From bf8417ed1a23fa4f18ba9469d92fb9bf93a9bf92 Mon Sep 17 00:00:00 2001 From: Spencer Date: Wed, 3 Mar 2021 08:45:55 -0700 Subject: [PATCH 1/7] [ci] separate checks done in bootstrap as individual tasks (#93329) (cherry picked from commit b790f4ca1761bc1fab7818318213833a9c7d092f) Co-authored-by: spalger --- .ci/Jenkinsfile_baseline_capture | 2 +- src/dev/ci_setup/bootstrap_validations.sh | 64 ------------------- src/dev/ci_setup/setup.sh | 16 +++-- test/scripts/checks/kbn_pm_dist.sh | 19 ++++++ test/scripts/checks/plugin_list_docs.sh | 19 ++++++ test/scripts/checks/plugin_public_api_docs.sh | 19 ++++++ vars/tasks.groovy | 3 + 7 files changed, 73 insertions(+), 69 deletions(-) delete mode 100644 src/dev/ci_setup/bootstrap_validations.sh create mode 100644 test/scripts/checks/kbn_pm_dist.sh create mode 100644 test/scripts/checks/plugin_list_docs.sh create mode 100644 test/scripts/checks/plugin_public_api_docs.sh diff --git a/.ci/Jenkinsfile_baseline_capture b/.ci/Jenkinsfile_baseline_capture index 672f5127a9796..7fefbbb26fd12 100644 --- a/.ci/Jenkinsfile_baseline_capture +++ b/.ci/Jenkinsfile_baseline_capture @@ -25,7 +25,7 @@ kibanaPipeline(timeoutMinutes: 210) { withEnv([ 'BUILD_TS_REFS_CACHE_ENABLE=true', 'BUILD_TS_REFS_CACHE_CAPTURE=true', - 'DISABLE_BOOTSTRAP_VALIDATIONS=true', + 'DISABLE_BOOTSTRAP_VALIDATION=true', ]) { kibanaPipeline.doSetup() } diff --git a/src/dev/ci_setup/bootstrap_validations.sh b/src/dev/ci_setup/bootstrap_validations.sh deleted file mode 100644 index 939269952dea1..0000000000000 --- a/src/dev/ci_setup/bootstrap_validations.sh +++ /dev/null @@ -1,64 +0,0 @@ -#!/usr/bin/env bash - -set -e - -### -### verify no git modifications caused by bootstrap -### -if [[ $DISABLE_BOOTSTRAP_VALIDATIONS != "true" ]]; then - GIT_CHANGES="$(git ls-files --modified)" - if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'yarn kbn bootstrap' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 - fi -fi - - -### -### rebuild kbn-pm distributable to ensure it's not out of date -### -echo " -- building kbn-pm distributable" -yarn kbn run build -i @kbn/pm - -### -### verify no git modifications -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'yarn kbn run build -i @kbn/pm' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi - -### -### rebuild plugin list to ensure it's not out of date -### -echo " -- building plugin list docs" -node scripts/build_plugin_list_docs - -### -### verify no git modifications -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'node scripts/build_plugin_list_docs' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi - -### -### rebuild plugin api docs to ensure it's not out of date -### -echo " -- building api docs" -node scripts/build_api_docs - -### -### verify no api changes -### -GIT_CHANGES="$(git ls-files --modified)" -if [ "$GIT_CHANGES" ]; then - echo -e "\n${RED}ERROR: 'node scripts/build_api_docs' caused changes to the following files:${C_RESET}\n" - echo -e "$GIT_CHANGES\n" - exit 1 -fi diff --git a/src/dev/ci_setup/setup.sh b/src/dev/ci_setup/setup.sh index 3c08b336f1628..dde1cb212c536 100755 --- a/src/dev/ci_setup/setup.sh +++ b/src/dev/ci_setup/setup.sh @@ -40,12 +40,20 @@ if [[ "$BUILD_TS_REFS_CACHE_CAPTURE" == "true" ]]; then cd "$KIBANA_DIR" fi -if [[ "$DISABLE_BOOTSTRAP_VALIDATIONS" != "true" ]]; then - source "$KIBANA_DIR/src/dev/ci_setup/bootstrap_validations.sh" -fi - ### ### Download es snapshots ### echo " -- downloading es snapshot" node scripts/es snapshot --download-only; + +### +### verify no git modifications caused by bootstrap +### +if [[ "$DISABLE_BOOTSTRAP_VALIDATION" != "true" ]]; then + GIT_CHANGES="$(git ls-files --modified)" + if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'yarn kbn bootstrap' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 + fi +fi diff --git a/test/scripts/checks/kbn_pm_dist.sh b/test/scripts/checks/kbn_pm_dist.sh new file mode 100644 index 0000000000000..3116404280cca --- /dev/null +++ b/test/scripts/checks/kbn_pm_dist.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash + +source src/dev/ci_setup/setup_env.sh + +### +### rebuild kbn-pm distributable to ensure it's not out of date +### +echo " -- building kbn-pm distributable" +yarn kbn run build -i @kbn/pm + +### +### verify no git modifications +### +GIT_CHANGES="$(git ls-files --modified)" +if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'yarn kbn run build -i @kbn/pm' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 +fi diff --git a/test/scripts/checks/plugin_list_docs.sh b/test/scripts/checks/plugin_list_docs.sh new file mode 100644 index 0000000000000..b0f49d7845841 --- /dev/null +++ b/test/scripts/checks/plugin_list_docs.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash + +source src/dev/ci_setup/setup_env.sh + +### +### rebuild plugin list to ensure it's not out of date +### +echo " -- building plugin list docs" +node scripts/build_plugin_list_docs + +### +### verify no git modifications +### +GIT_CHANGES="$(git ls-files --modified)" +if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'node scripts/build_plugin_list_docs' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 +fi diff --git a/test/scripts/checks/plugin_public_api_docs.sh b/test/scripts/checks/plugin_public_api_docs.sh new file mode 100644 index 0000000000000..ffa6afbc9d177 --- /dev/null +++ b/test/scripts/checks/plugin_public_api_docs.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash + +source src/dev/ci_setup/setup_env.sh + +### +### rebuild plugin api docs to ensure it's not out of date +### +echo " -- building api docs" +node scripts/build_api_docs + +### +### verify no api changes +### +GIT_CHANGES="$(git ls-files --modified)" +if [ "$GIT_CHANGES" ]; then + echo -e "\n${RED}ERROR: 'node scripts/build_api_docs' caused changes to the following files:${C_RESET}\n" + echo -e "$GIT_CHANGES\n" + exit 1 +fi diff --git a/vars/tasks.groovy b/vars/tasks.groovy index a61035403dabd..7ed6de8094067 100644 --- a/vars/tasks.groovy +++ b/vars/tasks.groovy @@ -9,6 +9,9 @@ def check() { kibanaPipeline.scriptTask('Check TypeScript Projects', 'test/scripts/checks/ts_projects.sh'), kibanaPipeline.scriptTask('Check Jest Configs', 'test/scripts/checks/jest_configs.sh'), kibanaPipeline.scriptTask('Check Doc API Changes', 'test/scripts/checks/doc_api_changes.sh'), + kibanaPipeline.scriptTask('Check @kbn/pm Distributable', 'test/scripts/checks/kbn_pm_dist.sh'), + kibanaPipeline.scriptTask('Check Plugin List Docs', 'test/scripts/checks/plugin_list_docs.sh'), + kibanaPipeline.scriptTask('Check Public API Docs', 'test/scripts/checks/plugin_public_api_docs.sh'), kibanaPipeline.scriptTask('Check Types', 'test/scripts/checks/type_check.sh'), kibanaPipeline.scriptTask('Check Bundle Limits', 'test/scripts/checks/bundle_limits.sh'), kibanaPipeline.scriptTask('Check i18n', 'test/scripts/checks/i18n.sh'), From ccc70b4960b81ef75945daef0189c93a93b47532 Mon Sep 17 00:00:00 2001 From: Melissa Alvarez Date: Wed, 3 Mar 2021 11:17:05 -0500 Subject: [PATCH 2/7] [ML] Data Frame Analytic: adds api integration tests for _start and _stop endpoints (#92532) * add start and stop endpoint tests * add start and stop within spaces endpoint tests * move start and start_spaces tests to separate files * wip: move stop and stop_spaces to separate files * use slow running job config so job is still running when stop request happens * check started job state is actually started * check job is stopped after stopping * add debug logs * ensure jobs are created/started before stopping attempt * remove unnecessary debug logs --- .../apis/ml/data_frame_analytics/index.ts | 4 + .../apis/ml/data_frame_analytics/start.ts | 136 ++++++++++++++++++ .../ml/data_frame_analytics/start_spaces.ts | 94 ++++++++++++ .../apis/ml/data_frame_analytics/stop.ts | 91 ++++++++++++ .../ml/data_frame_analytics/stop_spaces.ts | 90 ++++++++++++ x-pack/test/functional/services/ml/api.ts | 17 ++- .../functional/services/ml/common_config.ts | 33 +++++ 7 files changed, 463 insertions(+), 2 deletions(-) create mode 100644 x-pack/test/api_integration/apis/ml/data_frame_analytics/start.ts create mode 100644 x-pack/test/api_integration/apis/ml/data_frame_analytics/start_spaces.ts create mode 100644 x-pack/test/api_integration/apis/ml/data_frame_analytics/stop.ts create mode 100644 x-pack/test/api_integration/apis/ml/data_frame_analytics/stop_spaces.ts diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/index.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/index.ts index b15e6d892b9e3..950f36d325c76 100644 --- a/x-pack/test/api_integration/apis/ml/data_frame_analytics/index.ts +++ b/x-pack/test/api_integration/apis/ml/data_frame_analytics/index.ts @@ -13,6 +13,10 @@ export default function ({ loadTestFile }: FtrProviderContext) { loadTestFile(require.resolve('./delete')); loadTestFile(require.resolve('./update')); loadTestFile(require.resolve('./create_job')); + loadTestFile(require.resolve('./start')); + loadTestFile(require.resolve('./stop')); + loadTestFile(require.resolve('./start_spaces')); + loadTestFile(require.resolve('./stop_spaces')); loadTestFile(require.resolve('./get_spaces')); loadTestFile(require.resolve('./update_spaces')); loadTestFile(require.resolve('./delete_spaces')); diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/start.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/start.ts new file mode 100644 index 0000000000000..6960dc37bf0f8 --- /dev/null +++ b/x-pack/test/api_integration/apis/ml/data_frame_analytics/start.ts @@ -0,0 +1,136 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../../ftr_provider_context'; +import { USER } from '../../../../functional/services/ml/security_common'; +import { DataFrameAnalyticsConfig } from '../../../../../plugins/ml/public/application/data_frame_analytics/common'; +import { DeepPartial } from '../../../../../plugins/ml/common/types/common'; +import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api'; +import { DATA_FRAME_TASK_STATE } from '../../../../../plugins/ml/common/constants/data_frame_analytics'; + +export default ({ getService }: FtrProviderContext) => { + const esArchiver = getService('esArchiver'); + const supertest = getService('supertestWithoutAuth'); + const ml = getService('ml'); + + const jobId = `bm_${Date.now()}`; + const generateDestinationIndex = (analyticsId: string) => `user-${analyticsId}`; + const commonJobConfig = { + source: { + index: ['ft_bank_marketing'], + query: { + match_all: {}, + }, + }, + analysis: { + classification: { + dependent_variable: 'y', + training_percent: 20, + }, + }, + analyzed_fields: { + includes: [], + excludes: [], + }, + model_memory_limit: '60mb', + allow_lazy_start: false, // default value + max_num_threads: 1, // default value + }; + const destinationIndex = generateDestinationIndex(`${jobId}_0`); + + const testJobConfigs: Array> = [ + { + id: `${jobId}_0`, + description: 'Test start for analytics', + dest: { + index: destinationIndex, + results_field: 'ml', + }, + ...commonJobConfig, + }, + ]; + + async function createJobs(mockJobConfigs: Array>) { + for (const jobConfig of mockJobConfigs) { + await ml.api.createDataFrameAnalyticsJob(jobConfig as DataFrameAnalyticsConfig); + } + } + + describe('POST data_frame/analytics/{analyticsId}/_start', () => { + before(async () => { + await esArchiver.loadIfNeeded('ml/bm_classification'); + await ml.testResources.setKibanaTimeZoneToUTC(); + await createJobs(testJobConfigs); + }); + + after(async () => { + await ml.api.deleteDataFrameAnalyticsJobES(`${jobId}_0`); + await ml.api.cleanMlIndices(); + await ml.api.deleteIndices(destinationIndex); + }); + + describe('StartDataFrameAnalyticsJob', () => { + it('should start analytics job for specified id if job exists', async () => { + const analyticsId = `${jobId}_0`; + + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${analyticsId}/_start`) + .auth(USER.ML_POWERUSER, ml.securityCommon.getPasswordForUser(USER.ML_POWERUSER)) + .set(COMMON_REQUEST_HEADERS) + .expect(200); + + expect(body).not.to.be(undefined); + expect(body.acknowledged).to.be(true); + expect(body.node).not.to.be(''); + + await ml.api.waitForAnalyticsState(analyticsId, DATA_FRAME_TASK_STATE.STARTED); + await ml.api.assertIndicesExist(destinationIndex); + }); + + it('should show 404 error if job does not exist', async () => { + const id = `${jobId}_invalid`; + const message = `No known job with id '${id}'`; + + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${id}/_start`) + .auth(USER.ML_POWERUSER, ml.securityCommon.getPasswordForUser(USER.ML_POWERUSER)) + .set(COMMON_REQUEST_HEADERS) + .expect(404); + + expect(body.error).to.eql('Not Found'); + expect(body.message).to.eql(message); + }); + + it('should not allow to start analytics job for unauthorized user', async () => { + const analyticsId = `${jobId}_0`; + + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${analyticsId}/_start`) + .auth(USER.ML_UNAUTHORIZED, ml.securityCommon.getPasswordForUser(USER.ML_UNAUTHORIZED)) + .set(COMMON_REQUEST_HEADERS) + .expect(403); + + expect(body.error).to.eql('Forbidden'); + expect(body.message).to.eql('Forbidden'); + }); + + it('should not allow to start analytics job for user with view only permission', async () => { + const analyticsId = `${jobId}_0`; + + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${analyticsId}/_start`) + .auth(USER.ML_VIEWER, ml.securityCommon.getPasswordForUser(USER.ML_VIEWER)) + .set(COMMON_REQUEST_HEADERS) + .expect(403); + + expect(body.error).to.eql('Forbidden'); + expect(body.message).to.eql('Forbidden'); + }); + }); + }); +}; diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/start_spaces.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/start_spaces.ts new file mode 100644 index 0000000000000..de8cc7ffb1c41 --- /dev/null +++ b/x-pack/test/api_integration/apis/ml/data_frame_analytics/start_spaces.ts @@ -0,0 +1,94 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; + +import { FtrProviderContext } from '../../../ftr_provider_context'; +import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api'; +import { USER } from '../../../../functional/services/ml/security_common'; +import { DATA_FRAME_TASK_STATE } from '../../../../../plugins/ml/common/constants/data_frame_analytics'; + +export default ({ getService }: FtrProviderContext) => { + const esArchiver = getService('esArchiver'); + const ml = getService('ml'); + const spacesService = getService('spaces'); + const supertest = getService('supertestWithoutAuth'); + + const jobIdSpace1 = 'ihp_od_space1'; + const jobIdSpace2 = 'ihp_od_space2'; + const idSpace1 = 'space1'; + const idSpace2 = 'space2'; + + const initialModelMemoryLimit = '17mb'; + + async function runStartRequest(jobId: string, space: string, expectedStatusCode: number) { + const { body } = await supertest + .post(`/s/${space}/api/ml/data_frame/analytics/${jobId}/_start`) + .auth( + USER.ML_POWERUSER_ALL_SPACES, + ml.securityCommon.getPasswordForUser(USER.ML_POWERUSER_ALL_SPACES) + ) + .set(COMMON_REQUEST_HEADERS) + .expect(expectedStatusCode); + + return body; + } + + let space1JobDestIndex: string; + let space2JobDestIndex: string; + + describe('POST data_frame/analytics/{analyticsId}/_start with spaces', function () { + before(async () => { + await esArchiver.loadIfNeeded('ml/ihp_outlier'); + await spacesService.create({ id: idSpace1, name: 'space_one', disabledFeatures: [] }); + await spacesService.create({ id: idSpace2, name: 'space_two', disabledFeatures: [] }); + + const jobConfigSpace1 = ml.commonConfig.getDFAIhpOutlierDetectionJobConfig(jobIdSpace1); + await ml.api.createDataFrameAnalyticsJob( + { ...jobConfigSpace1, model_memory_limit: initialModelMemoryLimit }, + idSpace1 + ); + + const jobConfigSpace2 = ml.commonConfig.getDFAIhpOutlierDetectionJobConfig(jobIdSpace2); + await ml.api.createDataFrameAnalyticsJob( + { ...jobConfigSpace2, model_memory_limit: initialModelMemoryLimit }, + idSpace2 + ); + + space1JobDestIndex = jobConfigSpace1.dest.index; + space2JobDestIndex = jobConfigSpace2.dest.index; + + await ml.testResources.setKibanaTimeZoneToUTC(); + }); + + after(async () => { + await ml.api.deleteDataFrameAnalyticsJobES(jobIdSpace1); + await ml.api.deleteDataFrameAnalyticsJobES(jobIdSpace2); + await spacesService.delete(idSpace1); + await spacesService.delete(idSpace2); + await ml.api.cleanMlIndices(); + await ml.api.deleteIndices(space1JobDestIndex); + await ml.api.deleteIndices(space2JobDestIndex); + await ml.testResources.cleanMLSavedObjects(); + }); + + it('should start job from same space', async () => { + const body = await runStartRequest(jobIdSpace1, idSpace1, 200); + expect(body).to.have.property('acknowledged', true); + + await ml.api.waitForAnalyticsState(jobIdSpace1, DATA_FRAME_TASK_STATE.STARTED); + await ml.api.assertIndicesExist(space1JobDestIndex); + }); + + it('should fail to start job from different space', async () => { + const body = await runStartRequest(jobIdSpace2, idSpace1, 404); + expect(body.error).to.eql('Not Found'); + + await ml.api.waitForAnalyticsState(jobIdSpace1, DATA_FRAME_TASK_STATE.STOPPED); + }); + }); +}; diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/stop.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/stop.ts new file mode 100644 index 0000000000000..e1f479b0d2fc7 --- /dev/null +++ b/x-pack/test/api_integration/apis/ml/data_frame_analytics/stop.ts @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import { FtrProviderContext } from '../../../ftr_provider_context'; +import { USER } from '../../../../functional/services/ml/security_common'; +import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api'; +import { DATA_FRAME_TASK_STATE } from '../../../../../plugins/ml/common/constants/data_frame_analytics'; + +export default ({ getService }: FtrProviderContext) => { + const esArchiver = getService('esArchiver'); + const supertest = getService('supertestWithoutAuth'); + const ml = getService('ml'); + + const jobId = `bm_${Date.now()}`; + const analyticsId = `${jobId}_1`; + let destinationIndex: string; + + describe('POST data_frame/analytics/{analyticsId}/_stop', () => { + before(async () => { + await esArchiver.loadIfNeeded('ml/bm_classification'); + await ml.testResources.setKibanaTimeZoneToUTC(); + // job config with high training percent so it takes longer to run + const slowRunningConfig = ml.commonConfig.getDFABmClassificationJobConfig(analyticsId); + destinationIndex = slowRunningConfig.dest.index; + + await ml.api.createDataFrameAnalyticsJob(slowRunningConfig); + await ml.api.runDFAJob(analyticsId); + }); + + after(async () => { + await ml.api.deleteDataFrameAnalyticsJobES(analyticsId); + await ml.api.cleanMlIndices(); + await ml.api.deleteIndices(destinationIndex); + }); + + describe('StopsDataFrameAnalyticsJob', () => { + it('should stop analytics job for specified id when job exists', async () => { + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${analyticsId}/_stop`) + .auth(USER.ML_POWERUSER, ml.securityCommon.getPasswordForUser(USER.ML_POWERUSER)) + .set(COMMON_REQUEST_HEADERS) + .expect(200); + + expect(body).not.to.be(undefined); + expect(body.stopped).to.be(true); + await ml.api.waitForAnalyticsState(analyticsId, DATA_FRAME_TASK_STATE.STOPPED, 5000); + }); + + it('should show 404 error if job does not exist', async () => { + const id = `${jobId}_invalid`; + const message = `No known job with id '${id}'`; + + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${id}/_stop`) + .auth(USER.ML_POWERUSER, ml.securityCommon.getPasswordForUser(USER.ML_POWERUSER)) + .set(COMMON_REQUEST_HEADERS) + .expect(404); + + expect(body.error).to.eql('Not Found'); + expect(body.message).to.eql(message); + }); + + it('should not allow to stop analytics job for unauthorized user', async () => { + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${analyticsId}/_stop`) + .auth(USER.ML_UNAUTHORIZED, ml.securityCommon.getPasswordForUser(USER.ML_UNAUTHORIZED)) + .set(COMMON_REQUEST_HEADERS) + .expect(403); + + expect(body.error).to.eql('Forbidden'); + expect(body.message).to.eql('Forbidden'); + }); + + it('should not allow to stop analytics job for user with view only permission', async () => { + const { body } = await supertest + .post(`/api/ml/data_frame/analytics/${analyticsId}/_stop`) + .auth(USER.ML_VIEWER, ml.securityCommon.getPasswordForUser(USER.ML_VIEWER)) + .set(COMMON_REQUEST_HEADERS) + .expect(403); + + expect(body.error).to.eql('Forbidden'); + expect(body.message).to.eql('Forbidden'); + }); + }); + }); +}; diff --git a/x-pack/test/api_integration/apis/ml/data_frame_analytics/stop_spaces.ts b/x-pack/test/api_integration/apis/ml/data_frame_analytics/stop_spaces.ts new file mode 100644 index 0000000000000..19ce61d840d93 --- /dev/null +++ b/x-pack/test/api_integration/apis/ml/data_frame_analytics/stop_spaces.ts @@ -0,0 +1,90 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; + +import { FtrProviderContext } from '../../../ftr_provider_context'; +import { COMMON_REQUEST_HEADERS } from '../../../../functional/services/ml/common_api'; +import { USER } from '../../../../functional/services/ml/security_common'; +import { DATA_FRAME_TASK_STATE } from '../../../../../plugins/ml/common/constants/data_frame_analytics'; + +export default ({ getService }: FtrProviderContext) => { + const esArchiver = getService('esArchiver'); + const ml = getService('ml'); + const spacesService = getService('spaces'); + const supertest = getService('supertestWithoutAuth'); + + const jobIdSpace3 = 'ihp_od_space3'; + const jobIdSpace4 = 'ihp_od_space4'; + const idSpace3 = 'space3'; + const idSpace4 = 'space4'; + + async function runRequest( + jobId: string, + space: string, + action: string, + expectedStatusCode: number + ) { + const resp = await supertest + .post(`/s/${space}/api/ml/data_frame/analytics/${jobId}/${action}`) + .auth( + USER.ML_POWERUSER_ALL_SPACES, + ml.securityCommon.getPasswordForUser(USER.ML_POWERUSER_ALL_SPACES) + ) + .set(COMMON_REQUEST_HEADERS); + const { body, status } = resp; + + expect(status).to.be(expectedStatusCode); + return body; + } + + describe('POST data_frame/analytics/{analyticsId}/_stop with spaces', function () { + before(async () => { + await esArchiver.loadIfNeeded('ml/bm_classification'); + await spacesService.create({ id: idSpace3, name: 'space_three', disabledFeatures: [] }); + await spacesService.create({ id: idSpace4, name: 'space_four', disabledFeatures: [] }); + // job config with high training percent so it takes longer to run + const jobConfigSpace3 = ml.commonConfig.getDFABmClassificationJobConfig(jobIdSpace3); + const jobConfigSpace4 = ml.commonConfig.getDFABmClassificationJobConfig(jobIdSpace4); + // create jobs + await ml.api.createDataFrameAnalyticsJob(jobConfigSpace3, idSpace3); + await ml.api.createDataFrameAnalyticsJob(jobConfigSpace4, idSpace4); + // start jobs + await runRequest(jobIdSpace3, idSpace3, '_start', 200); + await ml.api.waitForAnalyticsState(jobIdSpace3, DATA_FRAME_TASK_STATE.STARTED); + await ml.api.assertIndicesExist(`user-${jobIdSpace3}`); + await runRequest(jobIdSpace4, idSpace4, '_start', 200); + await ml.api.waitForAnalyticsState(jobIdSpace4, DATA_FRAME_TASK_STATE.STARTED); + await ml.api.assertIndicesExist(`user-${jobIdSpace4}`); + + await ml.testResources.setKibanaTimeZoneToUTC(); + }); + + after(async () => { + await ml.api.deleteDataFrameAnalyticsJobES(jobIdSpace3); + await ml.api.deleteDataFrameAnalyticsJobES(jobIdSpace4); + await spacesService.delete(idSpace3); + await spacesService.delete(idSpace4); + await ml.api.deleteIndices(`user-${jobIdSpace3}`); + await ml.api.deleteIndices(`user-${jobIdSpace4}`); + await ml.api.cleanMlIndices(); + await ml.testResources.cleanMLSavedObjects(); + }); + + it('should stop job from same space', async () => { + const body = await runRequest(jobIdSpace3, idSpace3, '_stop', 200); + expect(body).to.have.property('stopped', true); + await ml.api.waitForAnalyticsState(jobIdSpace3, DATA_FRAME_TASK_STATE.STOPPED, 5000); + }); + + it('should fail to stop job from different space', async () => { + const body = await runRequest(jobIdSpace4, idSpace3, '_stop', 404); + expect(body.error).to.eql('Not Found'); + await ml.api.waitForAnalyticsState(jobIdSpace4, DATA_FRAME_TASK_STATE.STARTED, 5000); + }); + }); +}; diff --git a/x-pack/test/functional/services/ml/api.ts b/x-pack/test/functional/services/ml/api.ts index f7c7ae1b9a7d4..c9cfe1fee4ef9 100644 --- a/x-pack/test/functional/services/ml/api.ts +++ b/x-pack/test/functional/services/ml/api.ts @@ -295,11 +295,12 @@ export function MachineLearningAPIProvider({ getService }: FtrProviderContext) { async waitForAnalyticsState( analyticsId: string, - expectedAnalyticsState: DataFrameTaskStateType + expectedAnalyticsState: DataFrameTaskStateType, + timeoutInMs: number = 2 * 60 * 1000 ) { await retry.waitForWithTimeout( `analytics state to be ${expectedAnalyticsState}`, - 2 * 60 * 1000, + timeoutInMs, async () => { const state = await this.getAnalyticsState(analyticsId); if (state === expectedAnalyticsState) { @@ -720,6 +721,18 @@ export function MachineLearningAPIProvider({ getService }: FtrProviderContext) { log.debug('> DFA job created.'); }, + async deleteDataFrameAnalyticsJobES(analyticsId: string) { + log.debug(`Deleting data frame analytics job with id '${analyticsId}' ...`); + + await esSupertest + .delete(`/_ml/data_frame/analytics/${analyticsId}`) + .query({ force: true }) + .expect(200); + + await this.waitForDataFrameAnalyticsJobNotToExist(analyticsId); + log.debug('> DFA job deleted.'); + }, + async getADJobRecordCount(jobId: string): Promise { const jobStats = await this.getADJobStats(jobId); diff --git a/x-pack/test/functional/services/ml/common_config.ts b/x-pack/test/functional/services/ml/common_config.ts index b194bb25995a1..a16c0b88de900 100644 --- a/x-pack/test/functional/services/ml/common_config.ts +++ b/x-pack/test/functional/services/ml/common_config.ts @@ -57,6 +57,30 @@ const FQ_DATAFEED_CONFIG: Datafeed = { query: { bool: { must: [{ match_all: {} }] } }, }; +const BM_CLASSIFICATION_CONFIG: DeepPartial = { + id: '', + description: 'Classification job based on the bank marketing dataset', + source: { + index: ['ft_bank_marketing'], + query: { + match_all: {}, + }, + }, + analysis: { + classification: { + dependent_variable: 'y', + training_percent: 80, + }, + }, + analyzed_fields: { + includes: [], + excludes: [], + }, + model_memory_limit: '80mb', + allow_lazy_start: false, + max_num_threads: 1, +}; + const IHP_OUTLIER_DETECTION_CONFIG: DeepPartial = { id: '', description: 'Outlier detection job based on the Iowa house prices dataset', @@ -109,5 +133,14 @@ export function MachineLearningCommonConfigsProvider({}: FtrProviderContext) { }; return dfaConfig as DataFrameAnalyticsConfig; }, + + getDFABmClassificationJobConfig(dfaId: string): DataFrameAnalyticsConfig { + const dfaConfig = { + ...BM_CLASSIFICATION_CONFIG, + id: dfaId, + dest: { ...BM_CLASSIFICATION_CONFIG.dest, index: `user-${dfaId}` }, + }; + return dfaConfig as DataFrameAnalyticsConfig; + }, }; } From f5e8b108da67caeadfd970a2af9113f1cc68c111 Mon Sep 17 00:00:00 2001 From: Mikhail Shustov Date: Wed, 3 Mar 2021 17:21:49 +0100 Subject: [PATCH 3/7] Attempt to reduce Core bundle size with type exports. (#92221) * compile core files as isolated modules * fix export problems for isolated modules * apply changes to kbn-test as core imports from it * fix some exports * fix lint errors * update new exports * fix eslint error * expand export * where it is possible * update docs * update docs * fix eslint error --- api_docs/core.json | 6001 ++++++++--------- api_docs/core_application.json | 20 +- api_docs/core_http.json | 216 +- api_docs/core_saved_objects.json | 3580 +++++----- ...gin-core-server.explanation.description.md | 11 - ...-plugin-core-server.explanation.details.md | 11 - .../kibana-plugin-core-server.explanation.md | 21 - ...na-plugin-core-server.explanation.value.md | 11 - .../core/server/kibana-plugin-core-server.md | 1 - ...savedobjectsrepository.incrementcounter.md | 2 +- .../src/functional_test_runner/lib/index.ts | 4 +- .../lib/providers/index.ts | 3 +- .../public/application/capabilities/index.ts | 2 +- src/core/public/application/index.ts | 8 +- src/core/public/chrome/chrome_service.tsx | 3 +- src/core/public/chrome/index.ts | 17 +- src/core/public/chrome/nav_links/index.ts | 5 +- .../public/chrome/recently_accessed/index.ts | 5 +- src/core/public/chrome/ui/header/index.ts | 7 +- src/core/public/chrome/ui/index.ts | 4 +- src/core/public/core_app/status/lib/index.ts | 6 +- src/core/public/doc_links/index.ts | 3 +- src/core/public/fatal_errors/index.ts | 5 +- src/core/public/i18n/index.ts | 3 +- src/core/public/index.ts | 29 +- src/core/public/injected_metadata/index.ts | 5 +- src/core/public/notifications/index.ts | 10 +- src/core/public/notifications/toasts/index.ts | 5 +- src/core/public/overlays/banners/index.ts | 3 +- src/core/public/overlays/flyout/index.ts | 3 +- src/core/public/overlays/index.ts | 15 +- src/core/public/overlays/modal/index.ts | 5 +- src/core/public/plugins/index.ts | 8 +- src/core/public/saved_objects/index.ts | 9 +- src/core/public/types.ts | 2 +- src/core/public/ui_settings/index.ts | 4 +- src/core/server/capabilities/index.ts | 6 +- src/core/server/capabilities/types.ts | 2 +- src/core/server/config/index.ts | 13 +- src/core/server/context/index.ts | 5 +- src/core/server/core_usage_data/index.ts | 4 +- src/core/server/csp/index.ts | 3 +- src/core/server/dev/index.ts | 3 +- src/core/server/elasticsearch/client/index.ts | 18 +- src/core/server/elasticsearch/index.ts | 10 +- src/core/server/elasticsearch/legacy/index.ts | 17 +- src/core/server/environment/index.ts | 6 +- src/core/server/external_url/index.ts | 6 +- src/core/server/http/index.ts | 47 +- src/core/server/http/router/index.ts | 32 +- src/core/server/http/router/request.ts | 1 - .../server/http/router/validator/index.ts | 4 +- src/core/server/http_resources/index.ts | 2 +- src/core/server/i18n/index.ts | 6 +- src/core/server/index.ts | 88 +- src/core/server/legacy/index.ts | 11 +- .../appenders/rewrite/policies/index.ts | 2 +- .../appenders/rewrite/policies/meta/index.ts | 8 +- .../appenders/rolling_file/policies/index.ts | 2 +- .../rolling_file/policies/size_limit/index.ts | 3 +- .../policies/time_interval/index.ts | 3 +- .../rolling_file/strategies/index.ts | 2 +- .../rolling_file/strategies/numeric/index.ts | 8 +- src/core/server/logging/index.ts | 25 +- .../logging/layouts/conversions/index.ts | 2 +- src/core/server/logging/logger.mock.ts | 3 +- src/core/server/metrics/collectors/index.ts | 5 +- src/core/server/metrics/index.ts | 4 +- src/core/server/plugins/index.ts | 8 +- src/core/server/saved_objects/export/index.ts | 5 +- src/core/server/saved_objects/import/index.ts | 5 +- src/core/server/saved_objects/index.ts | 30 +- .../server/saved_objects/mappings/index.ts | 2 +- .../saved_objects/migrations/core/index.ts | 9 +- .../server/saved_objects/migrations/index.ts | 7 +- .../saved_objects/migrations/kibana/index.ts | 3 +- .../migrationsv2/actions/index.ts | 2 +- .../saved_objects/object_types/index.ts | 2 +- .../saved_objects/serialization/index.ts | 2 +- .../server/saved_objects/service/index.ts | 7 +- .../server/saved_objects/service/lib/index.ts | 7 +- src/core/server/saved_objects/types.ts | 4 +- src/core/server/server.api.md | 11 +- src/core/server/types.ts | 2 +- src/core/server/ui_settings/index.ts | 4 +- src/core/server/ui_settings/types.ts | 2 +- src/core/server/utils/crypto/index.ts | 3 +- src/core/tsconfig.json | 3 +- 88 files changed, 5230 insertions(+), 5286 deletions(-) delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.description.md delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.details.md delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.md delete mode 100644 docs/development/core/server/kibana-plugin-core-server.explanation.value.md diff --git a/api_docs/core.json b/api_docs/core.json index ad83038c3fb3f..4d0f9dac3bf96 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -4345,8 +4345,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 208, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L208" + "lineNumber": 207, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L207" }, "signature": [ { @@ -4368,8 +4368,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 210, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L210" + "lineNumber": 209, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L209" }, "signature": [ { @@ -4391,8 +4391,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 212, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L212" + "lineNumber": 211, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L211" }, "signature": [ { @@ -4414,8 +4414,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 214, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L214" + "lineNumber": 213, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L213" }, "signature": [ { @@ -4437,8 +4437,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 216, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L216" + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L215" }, "signature": [ { @@ -4462,8 +4462,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 223, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L223" + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L222" }, "signature": [ "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" @@ -4479,8 +4479,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 227, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L227" + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L226" }, "signature": [ { @@ -4496,8 +4496,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 206, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L206" + "lineNumber": 205, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L205" }, "initialIsOpen": false }, @@ -4524,8 +4524,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 253, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L253" + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L252" }, "signature": [ { @@ -4547,8 +4547,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 255, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L255" + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L254" }, "signature": [ { @@ -4570,8 +4570,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 257, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L257" + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L256" }, "signature": [ { @@ -4593,8 +4593,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 259, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L259" + "lineNumber": 258, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L258" }, "signature": [ { @@ -4616,8 +4616,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 261, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L261" + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L260" }, "signature": [ { @@ -4639,8 +4639,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 263, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L263" + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L262" }, "signature": [ { @@ -4662,8 +4662,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 265, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L265" + "lineNumber": 264, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L264" }, "signature": [ { @@ -4685,8 +4685,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 267, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L267" + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L266" }, "signature": [ { @@ -4708,8 +4708,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 269, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L269" + "lineNumber": 268, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L268" }, "signature": [ { @@ -4731,8 +4731,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 271, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L271" + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L270" }, "signature": [ { @@ -4756,8 +4756,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 278, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L278" + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L277" }, "signature": [ "{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }" @@ -4766,8 +4766,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 251, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L251" + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L250" }, "initialIsOpen": false }, @@ -6287,8 +6287,8 @@ ], "source": { "path": "src/core/public/index.ts", - "lineNumber": 237, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L237" + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L236" }, "signature": [ "() => Promise<[", @@ -6499,350 +6499,331 @@ "initialIsOpen": false }, { - "id": "def-server.LegacyClusterClient", + "id": "def-server.ElasticsearchConfig", "type": "Class", "tags": [ - "deprecated", "public" ], - "label": "LegacyClusterClient", + "label": "ElasticsearchConfig", "description": [ - "\n{@inheritDoc IClusterClient}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" - }, - " implements Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyClusterClient", - "text": "LegacyClusterClient" - }, - ", \"callAsInternalUser\" | \"asScoped\">" + "\nWrapper of config schema." ], "children": [ { - "id": "def-server.LegacyClusterClient.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], - "children": [ - { - "type": "CompoundType", - "label": "config", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyElasticsearchClientConfig", - "text": "LegacyElasticsearchClientConfig" - } - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 122, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L122" - } - }, - { - "type": "Object", - "label": "log", - "isRequired": true, - "signature": [ - "Logger" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 123, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L123" - } - }, - { - "type": "string", - "label": "type", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 124, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L124" - } - }, - { - "type": "Function", - "label": "getAuthHeaders", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.GetAuthHeaders", - "text": "GetAuthHeaders" - } - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L125" - } - } - ], "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 121, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L121" - } - }, - { - "id": "def-server.LegacyClusterClient.callAsInternalUser", - "type": "Function", - "children": [ - { - "type": "string", - "label": "endpoint", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 141, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L141" - } - }, - { - "type": "Object", - "label": "clientParams", - "isRequired": true, - "signature": [ - "Record" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 142, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L142" - } - }, - { - "type": "Object", - "label": "options", - "isRequired": false, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" - }, - " | undefined" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 143, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L143" - } - } - ], - "signature": [ - "(endpoint: string, clientParams?: Record, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" - }, - " | undefined) => Promise" - ], + "id": "def-server.ElasticsearchConfig.healthCheckDelay", + "type": "Object", + "label": "healthCheckDelay", "description": [ - "\nCalls specified endpoint with provided clientParams on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." + "\nThe interval between health check requests Kibana sends to the Elasticsearch." ], - "label": "callAsInternalUser", "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 140, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L140" + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L192" }, - "tags": [ - "deprecated" - ], - "returnComment": [] + "signature": [ + "moment.Duration" + ] }, { - "id": "def-server.LegacyClusterClient.close", - "type": "Function", - "label": "close", - "signature": [ - "() => void" - ], + "tags": [], + "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", + "type": "boolean", + "label": "ignoreVersionMismatch", "description": [ - "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." ], - "children": [], - "tags": [], - "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 158, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L158" + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 197, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L197" } }, { - "id": "def-server.LegacyClusterClient.asScoped", - "type": "Function", - "label": "asScoped", - "signature": [ - "(request?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" - }, - " | undefined) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyScopedClusterClient", - "text": "LegacyScopedClusterClient" - }, - ", \"callAsCurrentUser\" | \"callAsInternalUser\">" + "tags": [], + "id": "def-server.ElasticsearchConfig.apiVersion", + "type": "string", + "label": "apiVersion", + "description": [ + "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L202" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.hosts", + "type": "Array", + "label": "hosts", "description": [ - "\nCreates an instance of {@link ILegacyScopedClusterClient} based on the configuration the\ncurrent cluster client that exposes additional `callAsCurrentUser` method\nscoped to the provided req. Consumers shouldn't worry about closing\nscoped client instances, these will be automatically closed as soon as the\noriginal cluster client isn't needed anymore and closed.\n" + "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L208" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", + "type": "Array", + "label": "requestHeadersWhitelist", + "description": [ + "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 215, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L215" + }, + "signature": [ + "string[]" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.pingTimeout", + "type": "Object", + "label": "pingTimeout", + "description": [ + "\nTimeout after which PING HTTP request will be aborted and retried." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L220" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.requestTimeout", + "type": "Object", + "label": "requestTimeout", + "description": [ + "\nTimeout after which HTTP request will be aborted and retried." ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 225, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L225" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.shardTimeout", + "type": "Object", + "label": "shardTimeout", + "description": [ + "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 230, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L230" + }, + "signature": [ + "moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.sniffOnStart", + "type": "boolean", + "label": "sniffOnStart", + "description": [ + "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L236" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.sniffInterval", + "type": "CompoundType", + "label": "sniffInterval", + "description": [ + "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 242, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L242" + }, + "signature": [ + "false | moment.Duration" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", + "type": "boolean", + "label": "sniffOnConnectionFault", + "description": [ + "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 248, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L248" + } + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.username", + "type": "string", + "label": "username", + "description": [ + "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L254" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.password", + "type": "string", + "label": "password", + "description": [ + "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L260" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.ssl", + "type": "CompoundType", + "label": "ssl", + "description": [ + "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L267" + }, + "signature": [ + "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" + ] + }, + { + "tags": [], + "id": "def-server.ElasticsearchConfig.customHeaders", + "type": "Object", + "label": "customHeaders", + "description": [ + "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." + ], + "source": { + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L277" + }, + "signature": [ + "Record" + ] + }, + { + "id": "def-server.ElasticsearchConfig.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { - "type": "CompoundType", - "label": "request", - "isRequired": false, + "type": "Object", + "label": "rawConfig", + "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" - }, - " | undefined" - ], - "description": [ - "- Request the `IScopedClusterClient` instance will be scoped to.\nSupports request optionality, Legacy.Request & FakeRequest for BWC with LegacyPlatform" + "Readonly<{ password?: string | undefined; username?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificate?: string | undefined; certificateAuthorities?: string | string[] | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; hosts: string | string[]; requestHeadersWhitelist: string | string[]; customHeaders: Record; logQueries: boolean; apiVersion: string; healthCheck: Readonly<{} & { delay: moment.Duration; }>; ignoreVersionMismatch: boolean; }>" ], + "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 181, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181" + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 279, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279" } } ], "tags": [], "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 181, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181" + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 279, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279" } } ], "source": { - "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", - "lineNumber": 104, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L104" + "path": "src/core/server/elasticsearch/elasticsearch_config.ts", + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L188" }, "initialIsOpen": false }, { - "id": "def-server.LegacyScopedClusterClient", + "id": "def-server.LegacyClusterClient", "type": "Class", "tags": [ "deprecated", "public" ], - "label": "LegacyScopedClusterClient", + "label": "LegacyClusterClient", "description": [ - "\n{@inheritDoc IScopedClusterClient}" + "\n{@inheritDoc IClusterClient}" ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyScopedClusterClient", - "text": "LegacyScopedClusterClient" + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" }, " implements Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyScopedClusterClient", - "text": "LegacyScopedClusterClient" + "section": "def-server.LegacyClusterClient", + "text": "LegacyClusterClient" }, - ", \"callAsCurrentUser\" | \"callAsInternalUser\">" + ", \"callAsInternalUser\" | \"asScoped\">" ], "children": [ { - "id": "def-server.LegacyScopedClusterClient.Unnamed", + "id": "def-server.LegacyClusterClient.Unnamed", "type": "Function", "label": "Constructor", "signature": [ @@ -6851,93 +6832,85 @@ "description": [], "children": [ { - "type": "Function", - "label": "internalAPICaller", + "type": "CompoundType", + "label": "config", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyAPICaller", - "text": "LegacyAPICaller" + "section": "def-server.LegacyElasticsearchClientConfig", + "text": "LegacyElasticsearchClientConfig" } ], "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L36" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 122, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L122" } }, { - "type": "Function", - "label": "scopedAPICaller", + "type": "Object", + "label": "log", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyAPICaller", - "text": "LegacyAPICaller" - } + "Logger" ], "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L37" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 123, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L123" } }, { - "type": "CompoundType", - "label": "headers", - "isRequired": false, + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L124" + } + }, + { + "type": "Function", + "label": "getAuthHeaders", + "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.Headers", - "text": "Headers" - }, - " | undefined" + "section": "def-server.GetAuthHeaders", + "text": "GetAuthHeaders" + } ], "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 38, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L38" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L125" } } ], "tags": [], "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 35, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L35" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 121, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L121" } }, { - "id": "def-server.LegacyScopedClusterClient.callAsInternalUser", + "id": "def-server.LegacyClusterClient.callAsInternalUser", "type": "Function", - "label": "callAsInternalUser", - "signature": [ - "(endpoint: string, clientParams?: Record, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" - }, - " | undefined) => Promise" - ], - "description": [ - "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." - ], "children": [ { "type": "string", @@ -6946,13 +6919,11 @@ "signature": [ "string" ], - "description": [ - "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." - ], + "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 55, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L55" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 141, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L141" } }, { @@ -6962,13 +6933,11 @@ "signature": [ "Record" ], - "description": [ - "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." - ], + "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 56, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L56" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 142, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L142" } }, { @@ -6985,410 +6954,441 @@ }, " | undefined" ], - "description": [ - "- Options that affect the way we call the API and process the result." - ], + "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 57, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L57" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L143" } } ], + "signature": [ + "(endpoint: string, clientParams?: Record, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nCalls specified endpoint with provided clientParams on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." + ], + "label": "callAsInternalUser", + "source": { + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 140, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L140" + }, "tags": [ "deprecated" ], + "returnComment": [] + }, + { + "id": "def-server.LegacyClusterClient.close", + "type": "Function", + "label": "close", + "signature": [ + "() => void" + ], + "description": [ + "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + ], + "children": [], + "tags": [], "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L54" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 158, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L158" } }, { - "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser", + "id": "def-server.LegacyClusterClient.asScoped", "type": "Function", - "label": "callAsCurrentUser", + "label": "asScoped", "signature": [ - "(endpoint: string, clientParams?: Record, options?: ", + "(request?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + }, + " | undefined) => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" }, - " | undefined) => Promise" + ", \"callAsCurrentUser\" | \"callAsInternalUser\">" ], "description": [ - "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nuser initiated request to the Kibana server (via HTTP request headers).\nSee {@link LegacyAPICaller}." + "\nCreates an instance of {@link ILegacyScopedClusterClient} based on the configuration the\ncurrent cluster client that exposes additional `callAsCurrentUser` method\nscoped to the provided req. Consumers shouldn't worry about closing\nscoped client instances, these will be automatically closed as soon as the\noriginal cluster client isn't needed anymore and closed.\n" ], "children": [ { - "type": "string", - "label": "endpoint", - "isRequired": true, - "signature": [ - "string" - ], - "description": [ - "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 73, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L73" - } - }, - { - "type": "Object", - "label": "clientParams", - "isRequired": true, - "signature": [ - "Record" - ], - "description": [ - "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 74, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L74" - } - }, - { - "type": "Object", - "label": "options", + "type": "CompoundType", + "label": "request", "isRequired": false, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LegacyCallAPIOptions", - "text": "LegacyCallAPIOptions" + "section": "def-server.FakeRequest", + "text": "FakeRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" }, " | undefined" ], "description": [ - "- Options that affect the way we call the API and process the result." + "- Request the `IScopedClusterClient` instance will be scoped to.\nSupports request optionality, Legacy.Request & FakeRequest for BWC with LegacyPlatform" ], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L75" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181" } } ], - "tags": [ - "deprecated" - ], + "tags": [], "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 72, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L72" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181" } } ], "source": { - "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L34" + "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", + "lineNumber": 104, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L104" }, "initialIsOpen": false }, { - "id": "def-server.ElasticsearchConfig", + "id": "def-server.LegacyScopedClusterClient", "type": "Class", "tags": [ + "deprecated", "public" ], - "label": "ElasticsearchConfig", + "label": "LegacyScopedClusterClient", "description": [ - "\nWrapper of config schema." + "\n{@inheritDoc IScopedClusterClient}" ], - "children": [ - { - "tags": [], - "id": "def-server.ElasticsearchConfig.healthCheckDelay", - "type": "Object", - "label": "healthCheckDelay", - "description": [ - "\nThe interval between health check requests Kibana sends to the Elasticsearch." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 192, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L192" - }, - "signature": [ - "moment.Duration" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.ignoreVersionMismatch", - "type": "boolean", - "label": "ignoreVersionMismatch", - "description": [ - "\nWhether to allow kibana to connect to a non-compatible elasticsearch node." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 197, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L197" - } - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.apiVersion", - "type": "string", - "label": "apiVersion", - "description": [ - "\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 202, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L202" - } - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.hosts", - "type": "Array", - "label": "hosts", - "description": [ - "\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 208, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L208" - }, - "signature": [ - "string[]" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.requestHeadersWhitelist", - "type": "Array", - "label": "requestHeadersWhitelist", - "description": [ - "\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 215, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L215" - }, - "signature": [ - "string[]" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.pingTimeout", - "type": "Object", - "label": "pingTimeout", - "description": [ - "\nTimeout after which PING HTTP request will be aborted and retried." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 220, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L220" - }, - "signature": [ - "moment.Duration" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.requestTimeout", - "type": "Object", - "label": "requestTimeout", - "description": [ - "\nTimeout after which HTTP request will be aborted and retried." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 225, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L225" - }, - "signature": [ - "moment.Duration" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.shardTimeout", - "type": "Object", - "label": "shardTimeout", - "description": [ - "\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 230, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L230" - }, - "signature": [ - "moment.Duration" - ] - }, + "signature": [ { - "tags": [], - "id": "def-server.ElasticsearchConfig.sniffOnStart", - "type": "boolean", - "label": "sniffOnStart", - "description": [ - "\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 236, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L236" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" }, + " implements Pick<", { - "tags": [], - "id": "def-server.ElasticsearchConfig.sniffInterval", - "type": "CompoundType", - "label": "sniffInterval", - "description": [ - "\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 242, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L242" - }, - "signature": [ - "false | moment.Duration" - ] + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyScopedClusterClient", + "text": "LegacyScopedClusterClient" }, + ", \"callAsCurrentUser\" | \"callAsInternalUser\">" + ], + "children": [ { - "tags": [], - "id": "def-server.ElasticsearchConfig.sniffOnConnectionFault", - "type": "boolean", - "label": "sniffOnConnectionFault", - "description": [ - "\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies." + "id": "def-server.LegacyScopedClusterClient.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "Function", + "label": "internalAPICaller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyAPICaller", + "text": "LegacyAPICaller" + } + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L36" + } + }, + { + "type": "Function", + "label": "scopedAPICaller", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyAPICaller", + "text": "LegacyAPICaller" + } + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L37" + } + }, + { + "type": "CompoundType", + "label": "headers", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L38" + } + } ], + "tags": [], + "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 248, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L248" + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L35" } }, { - "tags": [], - "id": "def-server.ElasticsearchConfig.username", - "type": "string", - "label": "username", - "description": [ - "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions." - ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 254, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L254" - }, + "id": "def-server.LegacyScopedClusterClient.callAsInternalUser", + "type": "Function", + "label": "callAsInternalUser", "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.password", - "type": "string", - "label": "password", - "description": [ - "\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions." + "(endpoint: string, clientParams?: Record, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined) => Promise" ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 260, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L260" - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.ssl", - "type": "CompoundType", - "label": "ssl", "description": [ - "\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`." + "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}." ], - "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 267, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L267" - }, - "signature": [ - "Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }" - ] - }, - { - "tags": [], - "id": "def-server.ElasticsearchConfig.customHeaders", - "type": "Object", - "label": "customHeaders", - "description": [ - "\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration." + "children": [ + { + "type": "string", + "label": "endpoint", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 55, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L55" + } + }, + { + "type": "Object", + "label": "clientParams", + "isRequired": true, + "signature": [ + "Record" + ], + "description": [ + "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 56, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L56" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined" + ], + "description": [ + "- Options that affect the way we call the API and process the result." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 57, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L57" + } + } + ], + "tags": [ + "deprecated" ], + "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 277, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L277" - }, - "signature": [ - "Record" - ] + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L54" + } }, { - "id": "def-server.ElasticsearchConfig.Unnamed", + "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser", "type": "Function", - "label": "Constructor", + "label": "callAsCurrentUser", "signature": [ - "any" + "(endpoint: string, clientParams?: Record, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined) => Promise" + ], + "description": [ + "\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nuser initiated request to the Kibana server (via HTTP request headers).\nSee {@link LegacyAPICaller}." ], - "description": [], "children": [ + { + "type": "string", + "label": "endpoint", + "isRequired": true, + "signature": [ + "string" + ], + "description": [ + "- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L73" + } + }, { "type": "Object", - "label": "rawConfig", + "label": "clientParams", "isRequired": true, "signature": [ - "Readonly<{ password?: string | undefined; username?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificate?: string | undefined; certificateAuthorities?: string | string[] | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; hosts: string | string[]; requestHeadersWhitelist: string | string[]; customHeaders: Record; logQueries: boolean; apiVersion: string; healthCheck: Readonly<{} & { delay: moment.Duration; }>; ignoreVersionMismatch: boolean; }>" + "Record" + ], + "description": [ + "- A dictionary of parameters that will be passed directly to the Elasticsearch JS client." ], - "description": [], "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 279, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279" + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 74, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L74" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LegacyCallAPIOptions", + "text": "LegacyCallAPIOptions" + }, + " | undefined" + ], + "description": [ + "- Options that affect the way we call the API and process the result." + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L75" } } ], - "tags": [], + "tags": [ + "deprecated" + ], "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 279, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279" + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L72" } } ], "source": { - "path": "src/core/server/elasticsearch/elasticsearch_config.ts", - "lineNumber": 188, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L188" + "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L34" }, "initialIsOpen": false }, @@ -9776,8 +9776,188 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 250, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L250" + "lineNumber": 250, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L250" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 251, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L251" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L252" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L253" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L254" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L255" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L256" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L257" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 258, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L258" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 259, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L259" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 260, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L260" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 261, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L261" + }, + "signature": [ + "any" + ] + }, + { + "id": "def-server.LegacyAPICaller.Unnamed", + "type": "Any", + "label": "Unnamed", + "tags": [], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 262, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L262" }, "signature": [ "any" @@ -9791,8 +9971,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 251, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L251" + "lineNumber": 263, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L263" }, "signature": [ "any" @@ -9806,8 +9986,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 252, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L252" + "lineNumber": 264, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L264" }, "signature": [ "any" @@ -9821,8 +10001,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 253, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L253" + "lineNumber": 265, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L265" }, "signature": [ "any" @@ -9836,8 +10016,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 254, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L254" + "lineNumber": 266, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L266" }, "signature": [ "any" @@ -9851,8 +10031,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 255, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L255" + "lineNumber": 267, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L267" }, "signature": [ "any" @@ -9866,8 +10046,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L256" + "lineNumber": 268, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L268" }, "signature": [ "any" @@ -9881,8 +10061,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 257, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L257" + "lineNumber": 269, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L269" }, "signature": [ "any" @@ -9896,8 +10076,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 258, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L258" + "lineNumber": 270, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L270" }, "signature": [ "any" @@ -9911,8 +10091,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 259, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L259" + "lineNumber": 271, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L271" }, "signature": [ "any" @@ -9926,8 +10106,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 260, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L260" + "lineNumber": 274, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L274" }, "signature": [ "any" @@ -9941,8 +10121,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 261, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L261" + "lineNumber": 275, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L275" }, "signature": [ "any" @@ -9956,8 +10136,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 262, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L262" + "lineNumber": 276, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L276" }, "signature": [ "any" @@ -9971,8 +10151,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 263, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L263" + "lineNumber": 277, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L277" }, "signature": [ "any" @@ -9986,8 +10166,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 264, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L264" + "lineNumber": 280, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L280" }, "signature": [ "any" @@ -10001,8 +10181,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 265, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L265" + "lineNumber": 281, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L281" }, "signature": [ "any" @@ -10016,8 +10196,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 266, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L266" + "lineNumber": 282, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L282" }, "signature": [ "any" @@ -10031,8 +10211,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 267, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L267" + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L285" }, "signature": [ "any" @@ -10046,8 +10226,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 268, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L268" + "lineNumber": 286, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L286" }, "signature": [ "any" @@ -10061,8 +10241,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 269, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L269" + "lineNumber": 287, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L287" }, "signature": [ "any" @@ -10076,8 +10256,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 270, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L270" + "lineNumber": 288, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L288" }, "signature": [ "any" @@ -10091,8 +10271,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 271, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L271" + "lineNumber": 289, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L289" }, "signature": [ "any" @@ -10106,8 +10286,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 274, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L274" + "lineNumber": 290, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L290" }, "signature": [ "any" @@ -10121,8 +10301,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 275, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L275" + "lineNumber": 291, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L291" }, "signature": [ "any" @@ -10136,8 +10316,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 276, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L276" + "lineNumber": 292, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L292" }, "signature": [ "any" @@ -10151,8 +10331,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 277, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L277" + "lineNumber": 293, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L293" }, "signature": [ "any" @@ -10166,8 +10346,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 280, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L280" + "lineNumber": 296, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L296" }, "signature": [ "any" @@ -10181,8 +10361,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 281, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L281" + "lineNumber": 297, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L297" }, "signature": [ "any" @@ -10196,8 +10376,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 282, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L282" + "lineNumber": 298, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L298" }, "signature": [ "any" @@ -10211,8 +10391,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 285, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L285" + "lineNumber": 301, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L301" }, "signature": [ "any" @@ -10226,8 +10406,8 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 286, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L286" + "lineNumber": 304, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L304" }, "signature": [ "any" @@ -10241,376 +10421,516 @@ "description": [], "source": { "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 287, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L287" + "lineNumber": 309, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L309" }, "signature": [ "any" ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L162" + }, + "initialIsOpen": false + }, + { + "id": "def-server.FakeRequest", + "type": "Interface", + "label": "FakeRequest", + "description": [ + "\nFake request object created manually by Kibana plugins." + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.FakeRequest.headers", + "type": "CompoundType", + "label": "headers", + "description": [ + "Headers used for authentication against Elasticsearch" + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 182, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L182" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.Headers", + "text": "Headers" + } + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/types.ts", + "lineNumber": 180, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L180" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IClusterClient", + "type": "Interface", + "label": "IClusterClient", + "description": [ + "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" + ], + "tags": [ + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.IClusterClient.asInternalUser", + "type": "CompoundType", + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 33, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L33" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } + ] }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 288, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L288" - }, - "signature": [ - "any" - ] + "tags": [], + "id": "def-server.IClusterClient.asScoped", + "type": "Function", + "label": "asScoped", + "description": [ + "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 37, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L37" + }, + "signature": [ + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L29" + }, + "initialIsOpen": false + }, + { + "id": "def-server.ICustomClusterClient", + "type": "Interface", + "label": "ICustomClusterClient", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ICustomClusterClient", + "text": "ICustomClusterClient" }, + " extends ", { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 289, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L289" - }, - "signature": [ - "any" - ] - }, + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IClusterClient", + "text": "IClusterClient" + } + ], + "description": [ + "\nSee {@link IClusterClient}\n" + ], + "tags": [ + "public" + ], + "children": [ { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], - "description": [], + "id": "def-server.ICustomClusterClient.close", + "type": "Function", + "label": "close", + "description": [ + "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 290, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L290" + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 50, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L50" }, "signature": [ - "any" + "() => Promise" ] - }, + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/cluster_client.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L45" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IScopedClusterClient", + "type": "Interface", + "label": "IScopedClusterClient", + "description": [ + "\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n" + ], + "tags": [ + "public" + ], + "children": [ { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], - "description": [], + "id": "def-server.IScopedClusterClient.asInternalUser", + "type": "CompoundType", + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 291, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L291" + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L24" }, "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ] }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], - "description": [], + "id": "def-server.IScopedClusterClient.asCurrentUser", + "type": "CompoundType", + "label": "asCurrentUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 292, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L292" + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L29" }, "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L19" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SearchResponse", + "type": "Interface", + "label": "SearchResponse", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.SearchResponse", + "text": "SearchResponse" }, + "" + ], + "description": [], + "tags": [ + "public" + ], + "children": [ { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SearchResponse.took", + "type": "number", + "label": "took", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 293, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L293" - }, - "signature": [ - "any" - ] + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L80" + } }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SearchResponse.timed_out", + "type": "boolean", + "label": "timed_out", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 296, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L296" - }, - "signature": [ - "any" - ] + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 81, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L81" + } }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SearchResponse._scroll_id", + "type": "string", + "label": "_scroll_id", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 297, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L297" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L82" }, "signature": [ - "any" + "string | undefined" ] }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SearchResponse._shards", + "type": "Object", + "label": "_shards", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 298, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L298" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L83" }, "signature": [ - "any" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ShardsResponse", + "text": "ShardsResponse" + } ] }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SearchResponse.hits", + "type": "Object", + "label": "hits", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 301, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L301" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L84" }, "signature": [ - "any" + "{ total: number; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number | undefined; _explanation?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Explanation", + "text": "Explanation" + }, + " | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: unknown[] | undefined; }[]; }" ] }, - { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", + { "tags": [], + "id": "def-server.SearchResponse.aggregations", + "type": "Any", + "label": "aggregations", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 304, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L304" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 102, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L102" }, "signature": [ "any" ] }, { - "id": "def-server.LegacyAPICaller.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], + "id": "def-server.SearchResponse.pit_id", + "type": "string", + "label": "pit_id", "description": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 309, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L309" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 103, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L103" }, "signature": [ - "any" + "string | undefined" ] } ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 162, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L162" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 79, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L79" }, "initialIsOpen": false }, { - "id": "def-server.FakeRequest", + "id": "def-server.CountResponse", "type": "Interface", - "label": "FakeRequest", - "description": [ - "\nFake request object created manually by Kibana plugins." - ], + "label": "CountResponse", + "description": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.FakeRequest.headers", - "type": "CompoundType", - "label": "headers", - "description": [ - "Headers used for authentication against Elasticsearch" - ], + "id": "def-server.CountResponse._shards", + "type": "Object", + "label": "_shards", + "description": [], "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 182, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L182" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 72, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L72" }, "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Headers", - "text": "Headers" + "docId": "kibCorePluginApi", + "section": "def-server.ShardsInfo", + "text": "ShardsInfo" } ] + }, + { + "tags": [], + "id": "def-server.CountResponse.count", + "type": "number", + "label": "count", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L73" + } } ], "source": { - "path": "src/core/server/elasticsearch/types.ts", - "lineNumber": 180, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L180" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L71" }, "initialIsOpen": false }, { - "id": "def-server.IClusterClient", + "id": "def-server.ShardsInfo", "type": "Interface", - "label": "IClusterClient", - "description": [ - "\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n" - ], + "label": "ShardsInfo", + "description": [], "tags": [ "public" ], "children": [ { "tags": [], - "id": "def-server.IClusterClient.asInternalUser", - "type": "CompoundType", - "label": "asInternalUser", - "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" - ], + "id": "def-server.ShardsInfo.total", + "type": "number", + "label": "total", + "description": [], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 33, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L33" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 62, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L62" + } }, { "tags": [], - "id": "def-server.IClusterClient.asScoped", - "type": "Function", - "label": "asScoped", - "description": [ - "\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}" - ], + "id": "def-server.ShardsInfo.successful", + "type": "number", + "label": "successful", + "description": [], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 37, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L37" - }, - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ScopeableRequest", - "text": "ScopeableRequest" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - } - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L29" - }, - "initialIsOpen": false - }, - { - "id": "def-server.ICustomClusterClient", - "type": "Interface", - "label": "ICustomClusterClient", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ICustomClusterClient", - "text": "ICustomClusterClient" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L63" + } }, - " extends ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IClusterClient", - "text": "IClusterClient" - } - ], - "description": [ - "\nSee {@link IClusterClient}\n" - ], - "tags": [ - "public" - ], - "children": [ + "tags": [], + "id": "def-server.ShardsInfo.skipped", + "type": "number", + "label": "skipped", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 64, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L64" + } + }, { "tags": [], - "id": "def-server.ICustomClusterClient.close", - "type": "Function", - "label": "close", - "description": [ - "\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API." - ], + "id": "def-server.ShardsInfo.failed", + "type": "number", + "label": "failed", + "description": [], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 50, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L50" - }, - "signature": [ - "() => Promise" - ] + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L65" + } } ], "source": { - "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L45" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 61, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L61" }, "initialIsOpen": false }, { - "id": "def-server.IScopedClusterClient", + "id": "def-server.ShardsResponse", "type": "Interface", - "label": "IScopedClusterClient", + "label": "ShardsResponse", "description": [ - "\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n" + "\nAll response typings are maintained until elasticsearch-js provides them out of the box\nhttps://github.com/elastic/elasticsearch-js/pull/970\n" ], "tags": [ "public" @@ -10618,69 +10938,71 @@ "children": [ { "tags": [], - "id": "def-server.IScopedClusterClient.asInternalUser", - "type": "CompoundType", - "label": "asInternalUser", - "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." - ], + "id": "def-server.ShardsResponse.total", + "type": "number", + "label": "total", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L43" + } + }, + { + "tags": [], + "id": "def-server.ShardsResponse.successful", + "type": "number", + "label": "successful", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L44" + } + }, + { + "tags": [], + "id": "def-server.ShardsResponse.failed", + "type": "number", + "label": "failed", + "description": [], "source": { - "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L24" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L45" + } }, { "tags": [], - "id": "def-server.IScopedClusterClient.asCurrentUser", - "type": "CompoundType", - "label": "asCurrentUser", - "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." - ], + "id": "def-server.ShardsResponse.skipped", + "type": "number", + "label": "skipped", + "description": [], "source": { - "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L29" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - } - ] + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L46" + } } ], "source": { - "path": "src/core/server/elasticsearch/client/scoped_cluster_client.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L19" + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L42" }, "initialIsOpen": false }, { - "id": "def-server.SearchResponse", + "id": "def-server.GetResponse", "type": "Interface", - "label": "SearchResponse", + "label": "GetResponse", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.SearchResponse", - "text": "SearchResponse" + "section": "def-server.GetResponse", + "text": "GetResponse" }, "" ], @@ -10691,38 +11013,62 @@ "children": [ { "tags": [], - "id": "def-server.SearchResponse.took", - "type": "number", - "label": "took", + "id": "def-server.GetResponse._index", + "type": "string", + "label": "_index", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L80" + "lineNumber": 110, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L110" } }, { "tags": [], - "id": "def-server.SearchResponse.timed_out", - "type": "boolean", - "label": "timed_out", + "id": "def-server.GetResponse._type", + "type": "string", + "label": "_type", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 81, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L81" + "lineNumber": 111, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L111" } }, { "tags": [], - "id": "def-server.SearchResponse._scroll_id", + "id": "def-server.GetResponse._id", "type": "string", - "label": "_scroll_id", + "label": "_id", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 82, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L82" + "lineNumber": 112, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L112" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._version", + "type": "number", + "label": "_version", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L113" + } + }, + { + "tags": [], + "id": "def-server.GetResponse._routing", + "type": "string", + "label": "_routing", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L114" }, "signature": [ "string | undefined" @@ -10730,90 +11076,67 @@ }, { "tags": [], - "id": "def-server.SearchResponse._shards", - "type": "Object", - "label": "_shards", + "id": "def-server.GetResponse.found", + "type": "boolean", + "label": "found", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 83, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L83" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ShardsResponse", - "text": "ShardsResponse" - } - ] + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L115" + } }, { "tags": [], - "id": "def-server.SearchResponse.hits", - "type": "Object", - "label": "hits", + "id": "def-server.GetResponse._source", + "type": "Uncategorized", + "label": "_source", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 84, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L84" + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L116" }, "signature": [ - "{ total: number; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number | undefined; _explanation?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Explanation", - "text": "Explanation" - }, - " | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: unknown[] | undefined; }[]; }" + "T" ] }, { "tags": [], - "id": "def-server.SearchResponse.aggregations", - "type": "Any", - "label": "aggregations", + "id": "def-server.GetResponse._seq_no", + "type": "number", + "label": "_seq_no", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 102, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L102" - }, - "signature": [ - "any" - ] + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L117" + } }, { "tags": [], - "id": "def-server.SearchResponse.pit_id", - "type": "string", - "label": "pit_id", + "id": "def-server.GetResponse._primary_term", + "type": "number", + "label": "_primary_term", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 103, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L103" - }, - "signature": [ - "string | undefined" - ] + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L118" + } } ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 79, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L79" + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L109" }, "initialIsOpen": false }, { - "id": "def-server.CountResponse", + "id": "def-server.DeleteDocumentResponse", "type": "Interface", - "label": "CountResponse", + "label": "DeleteDocumentResponse", "description": [], "tags": [ "public" @@ -10821,503 +11144,546 @@ "children": [ { "tags": [], - "id": "def-server.CountResponse._shards", + "id": "def-server.DeleteDocumentResponse._shards", "type": "Object", "label": "_shards", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 72, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L72" + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L125" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ShardsInfo", - "text": "ShardsInfo" + "section": "def-server.ShardsResponse", + "text": "ShardsResponse" } ] }, { "tags": [], - "id": "def-server.CountResponse.count", - "type": "number", - "label": "count", + "id": "def-server.DeleteDocumentResponse.found", + "type": "boolean", + "label": "found", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 73, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L73" + "lineNumber": 126, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L126" } - } - ], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L71" - }, - "initialIsOpen": false - }, - { - "id": "def-server.ShardsInfo", - "type": "Interface", - "label": "ShardsInfo", - "description": [], - "tags": [ - "public" - ], - "children": [ + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._index", + "type": "string", + "label": "_index", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 127, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L127" + } + }, + { + "tags": [], + "id": "def-server.DeleteDocumentResponse._type", + "type": "string", + "label": "_type", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/client/types.ts", + "lineNumber": 128, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L128" + } + }, { "tags": [], - "id": "def-server.ShardsInfo.total", - "type": "number", - "label": "total", + "id": "def-server.DeleteDocumentResponse._id", + "type": "string", + "label": "_id", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 62, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L62" + "lineNumber": 129, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L129" } }, { "tags": [], - "id": "def-server.ShardsInfo.successful", + "id": "def-server.DeleteDocumentResponse._version", "type": "number", - "label": "successful", + "label": "_version", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 63, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L63" + "lineNumber": 130, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L130" } }, { "tags": [], - "id": "def-server.ShardsInfo.skipped", - "type": "number", - "label": "skipped", + "id": "def-server.DeleteDocumentResponse.result", + "type": "string", + "label": "result", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 64, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L64" + "lineNumber": 131, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L131" } }, { "tags": [], - "id": "def-server.ShardsInfo.failed", - "type": "number", - "label": "failed", + "id": "def-server.DeleteDocumentResponse.error", + "type": "Object", + "label": "error", "description": [], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 65, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L65" - } + "lineNumber": 132, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L132" + }, + "signature": [ + "{ type: string; } | undefined" + ] } ], "source": { "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 61, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L61" + "lineNumber": 124, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L124" }, "initialIsOpen": false }, { - "id": "def-server.ShardsResponse", + "id": "def-server.LegacyCallAPIOptions", "type": "Interface", - "label": "ShardsResponse", + "label": "LegacyCallAPIOptions", "description": [ - "\nAll response typings are maintained until elasticsearch-js provides them out of the box\nhttps://github.com/elastic/elasticsearch-js/pull/970\n" + "\nThe set of options that defines how API call should be made and result be\nprocessed.\n" ], "tags": [ - "public" + "public", + "deprecated" ], "children": [ { "tags": [], - "id": "def-server.ShardsResponse.total", - "type": "number", - "label": "total", - "description": [], + "id": "def-server.LegacyCallAPIOptions.wrap401Errors", + "type": "CompoundType", + "label": "wrap401Errors", + "description": [ + "\nIndicates whether `401 Unauthorized` errors returned from the Elasticsearch API\nshould be wrapped into `Boom` error instances with properly set `WWW-Authenticate`\nheader that could have been returned by the API itself. If API didn't specify that\nthen `Basic realm=\"Authorization Required\"` is used as `WWW-Authenticate`." + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L43" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 151, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L151" + }, + "signature": [ + "boolean | undefined" + ] }, { "tags": [], - "id": "def-server.ShardsResponse.successful", - "type": "number", - "label": "successful", - "description": [], + "id": "def-server.LegacyCallAPIOptions.signal", + "type": "Object", + "label": "signal", + "description": [ + "\nA signal object that allows you to abort the request via an AbortController object." + ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L44" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 155, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L155" + }, + "signature": [ + "AbortSignal | undefined" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L144" + }, + "initialIsOpen": false + }, + { + "id": "def-server.AssistantAPIClientParams", + "type": "Interface", + "label": "AssistantAPIClientParams", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.AssistantAPIClientParams", + "text": "AssistantAPIClientParams" }, + " extends ", + "GenericParams" + ], + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ { "tags": [], - "id": "def-server.ShardsResponse.failed", - "type": "number", - "label": "failed", + "id": "def-server.AssistantAPIClientParams.path", + "type": "string", + "label": "path", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L45" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 318, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L318" + }, + "signature": [ + "\"/_migration/assistance\"" + ] }, { "tags": [], - "id": "def-server.ShardsResponse.skipped", - "type": "number", - "label": "skipped", + "id": "def-server.AssistantAPIClientParams.method", + "type": "string", + "label": "method", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 46, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L46" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 319, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L319" + }, + "signature": [ + "\"GET\"" + ] } ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 42, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L42" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 317, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L317" }, "initialIsOpen": false }, { - "id": "def-server.Explanation", + "id": "def-server.AssistanceAPIResponse", "type": "Interface", - "label": "Explanation", + "label": "AssistanceAPIResponse", "description": [], "tags": [ + "deprecated", "public" ], "children": [ { "tags": [], - "id": "def-server.Explanation.value", - "type": "number", - "label": "value", + "id": "def-server.AssistanceAPIResponse.indices", + "type": "Object", + "label": "indices", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 53, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L53" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 338, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L338" + }, + "signature": [ + "{ [indexName: string]: { action_required: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", + "text": "MIGRATION_ASSISTANCE_INDEX_ACTION" + }, + "; }; }" + ] + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 337, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L337" + }, + "initialIsOpen": false + }, + { + "id": "def-server.DeprecationAPIClientParams", + "type": "Interface", + "label": "DeprecationAPIClientParams", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationAPIClientParams", + "text": "DeprecationAPIClientParams" }, + " extends ", + "GenericParams" + ], + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ { "tags": [], - "id": "def-server.Explanation.description", + "id": "def-server.DeprecationAPIClientParams.path", "type": "string", - "label": "description", + "label": "path", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L54" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 350, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L350" + }, + "signature": [ + "\"/_migration/deprecations\"" + ] }, { "tags": [], - "id": "def-server.Explanation.details", - "type": "Array", - "label": "details", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 55, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L55" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Explanation", - "text": "Explanation" - }, - "[]" + "id": "def-server.DeprecationAPIClientParams.method", + "type": "string", + "label": "method", + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 351, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L351" + }, + "signature": [ + "\"GET\"" ] } ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 52, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L52" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 349, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L349" }, "initialIsOpen": false }, { - "id": "def-server.GetResponse", + "id": "def-server.DeprecationInfo", "type": "Interface", - "label": "GetResponse", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetResponse", - "text": "GetResponse" - }, - "" - ], + "label": "DeprecationInfo", "description": [], "tags": [ + "deprecated", "public" ], "children": [ { "tags": [], - "id": "def-server.GetResponse._index", - "type": "string", - "label": "_index", + "id": "def-server.DeprecationInfo.level", + "type": "CompoundType", + "label": "level", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 110, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L110" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 359, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L359" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.MIGRATION_DEPRECATION_LEVEL", + "text": "MIGRATION_DEPRECATION_LEVEL" + } + ] }, { "tags": [], - "id": "def-server.GetResponse._type", + "id": "def-server.DeprecationInfo.message", "type": "string", - "label": "_type", + "label": "message", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 111, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L111" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 360, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L360" } }, { "tags": [], - "id": "def-server.GetResponse._id", + "id": "def-server.DeprecationInfo.url", "type": "string", - "label": "_id", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 112, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L112" - } - }, - { - "tags": [], - "id": "def-server.GetResponse._version", - "type": "number", - "label": "_version", + "label": "url", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 113, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L113" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 361, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L361" } }, { "tags": [], - "id": "def-server.GetResponse._routing", + "id": "def-server.DeprecationInfo.details", "type": "string", - "label": "_routing", + "label": "details", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 114, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L114" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 362, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L362" }, "signature": [ "string | undefined" ] - }, - { - "tags": [], - "id": "def-server.GetResponse.found", - "type": "boolean", - "label": "found", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L115" - } - }, + } + ], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 358, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L358" + }, + "initialIsOpen": false + }, + { + "id": "def-server.IndexSettingsDeprecationInfo", + "type": "Interface", + "label": "IndexSettingsDeprecationInfo", + "description": [], + "tags": [ + "deprecated", + "public" + ], + "children": [ { + "id": "def-server.IndexSettingsDeprecationInfo.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "id": "def-server.GetResponse._source", - "type": "Uncategorized", - "label": "_source", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 116, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L116" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 370, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L370" }, "signature": [ - "T" + "any" ] - }, - { - "tags": [], - "id": "def-server.GetResponse._seq_no", - "type": "number", - "label": "_seq_no", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L117" - } - }, - { - "tags": [], - "id": "def-server.GetResponse._primary_term", - "type": "number", - "label": "_primary_term", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L118" - } } ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 109, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L109" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 369, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L369" }, "initialIsOpen": false }, { - "id": "def-server.DeleteDocumentResponse", + "id": "def-server.DeprecationAPIResponse", "type": "Interface", - "label": "DeleteDocumentResponse", + "label": "DeprecationAPIResponse", "description": [], "tags": [ + "deprecated", "public" ], "children": [ { "tags": [], - "id": "def-server.DeleteDocumentResponse._shards", - "type": "Object", - "label": "_shards", + "id": "def-server.DeprecationAPIResponse.cluster_settings", + "type": "Array", + "label": "cluster_settings", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L125" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 378, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L378" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ShardsResponse", - "text": "ShardsResponse" - } + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" ] }, { "tags": [], - "id": "def-server.DeleteDocumentResponse.found", - "type": "boolean", - "label": "found", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 126, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L126" - } - }, - { - "tags": [], - "id": "def-server.DeleteDocumentResponse._index", - "type": "string", - "label": "_index", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 127, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L127" - } - }, - { - "tags": [], - "id": "def-server.DeleteDocumentResponse._type", - "type": "string", - "label": "_type", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 128, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L128" - } - }, - { - "tags": [], - "id": "def-server.DeleteDocumentResponse._id", - "type": "string", - "label": "_id", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 129, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L129" - } - }, - { - "tags": [], - "id": "def-server.DeleteDocumentResponse._version", - "type": "number", - "label": "_version", + "id": "def-server.DeprecationAPIResponse.ml_settings", + "type": "Array", + "label": "ml_settings", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 130, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L130" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 379, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L379" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ] }, { "tags": [], - "id": "def-server.DeleteDocumentResponse.result", - "type": "string", - "label": "result", + "id": "def-server.DeprecationAPIResponse.node_settings", + "type": "Array", + "label": "node_settings", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 131, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L131" - } + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 380, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L380" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationInfo", + "text": "DeprecationInfo" + }, + "[]" + ] }, { "tags": [], - "id": "def-server.DeleteDocumentResponse.error", + "id": "def-server.DeprecationAPIResponse.index_settings", "type": "Object", - "label": "error", + "label": "index_settings", "description": [], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 132, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L132" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 381, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L381" }, "signature": [ - "{ type: string; } | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IndexSettingsDeprecationInfo", + "text": "IndexSettingsDeprecationInfo" + } ] } ], "source": { - "path": "src/core/server/elasticsearch/client/types.ts", - "lineNumber": 124, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L124" + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 377, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L377" }, "initialIsOpen": false }, @@ -14578,256 +14944,37 @@ "\nUnique identifier for the categories" ], "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 19, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L19" - } - }, - { - "tags": [], - "id": "def-server.AppCategory.label", - "type": "string", - "label": "label", - "description": [ - "\nLabel used for category name.\nAlso used as aria-label if one isn't set." - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 25, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L25" - } - }, - { - "tags": [], - "id": "def-server.AppCategory.ariaLabel", - "type": "string", - "label": "ariaLabel", - "description": [ - "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L31" - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AppCategory.order", - "type": "number", - "label": "order", - "description": [ - "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 38, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L38" - }, - "signature": [ - "number | undefined" - ] - }, - { - "tags": [], - "id": "def-server.AppCategory.euiIconType", - "type": "string", - "label": "euiIconType", - "description": [ - "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L45" - }, - "signature": [ - "string | undefined" - ] - } - ], - "source": { - "path": "src/core/types/app_category.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L15" - }, - "initialIsOpen": false - }, - { - "id": "def-server.SavedObject", - "type": "Interface", - "label": "SavedObject", - "signature": [ - "SavedObject", - "" - ], - "description": [], - "tags": [], - "children": [ - { - "tags": [], - "id": "def-server.SavedObject.id", - "type": "string", - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71" - } - }, - { - "tags": [], - "id": "def-server.SavedObject.type", - "type": "string", - "label": "type", - "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 73, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73" - } - }, - { - "tags": [], - "id": "def-server.SavedObject.version", - "type": "string", - "label": "version", - "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75" - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.SavedObject.updated_at", - "type": "string", - "label": "updated_at", - "description": [ - "Timestamp of the last time this document had been updated." - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 77, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77" - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-server.SavedObject.error", - "type": "Object", - "label": "error", - "description": [], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 78, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78" - }, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-server.SavedObject.attributes", - "type": "Uncategorized", - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 80, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80" - }, - "signature": [ - "T" - ] - }, - { - "tags": [], - "id": "def-server.SavedObject.references", - "type": "Array", - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 82, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82" - }, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, - "[]" - ] + "path": "src/core/types/app_category.ts", + "lineNumber": 19, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L19" + } }, { "tags": [], - "id": "def-server.SavedObject.migrationVersion", - "type": "Object", - "label": "migrationVersion", + "id": "def-server.AppCategory.label", + "type": "string", + "label": "label", "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" + "\nLabel used for category name.\nAlso used as aria-label if one isn't set." ], "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 84, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84" - }, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, - " | undefined" - ] + "path": "src/core/types/app_category.ts", + "lineNumber": 25, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L25" + } }, { "tags": [], - "id": "def-server.SavedObject.coreMigrationVersion", + "id": "def-server.AppCategory.ariaLabel", "type": "string", - "label": "coreMigrationVersion", + "label": "ariaLabel", "description": [ - "A semver value that is used when upgrading objects between Kibana versions." + "\nIf the visual label isn't appropriate for screen readers,\ncan override it here" ], "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86" + "path": "src/core/types/app_category.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L31" }, "signature": [ "string | undefined" @@ -14835,33 +14982,33 @@ }, { "tags": [], - "id": "def-server.SavedObject.namespaces", - "type": "Array", - "label": "namespaces", + "id": "def-server.AppCategory.order", + "type": "number", + "label": "order", "description": [ - "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." + "\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)" ], "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 88, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88" + "path": "src/core/types/app_category.ts", + "lineNumber": 38, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L38" }, "signature": [ - "string[] | undefined" + "number | undefined" ] }, { "tags": [], - "id": "def-server.SavedObject.originId", + "id": "def-server.AppCategory.euiIconType", "type": "string", - "label": "originId", + "label": "euiIconType", "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + "\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined" ], "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 95, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95" + "path": "src/core/types/app_category.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L45" }, "signature": [ "string | undefined" @@ -14869,1935 +15016,1725 @@ } ], "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 69, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69" - }, - "initialIsOpen": false - }, - { - "id": "def-server.SavedObjectAttributes", - "type": "Interface", - "label": "SavedObjectAttributes", - "description": [ - "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.SavedObjectAttributes.Unnamed", - "type": "Any", - "label": "Unnamed", - "tags": [], - "description": [], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L36" - }, - "signature": [ - "any" - ] - } - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 35, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L35" + "path": "src/core/types/app_category.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L15" }, "initialIsOpen": false }, { - "id": "def-server.SavedObjectReference", + "id": "def-server.SavedObject", "type": "Interface", - "label": "SavedObjectReference", - "description": [ - "\nA reference to another saved object.\n" - ], - "tags": [ - "public" + "label": "SavedObject", + "signature": [ + "SavedObject", + "" ], + "description": [], + "tags": [], "children": [ { "tags": [], - "id": "def-server.SavedObjectReference.name", + "id": "def-server.SavedObject.id", "type": "string", - "label": "name", - "description": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L45" + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71" } }, { "tags": [], - "id": "def-server.SavedObjectReference.type", + "id": "def-server.SavedObject.type", "type": "string", "label": "type", - "description": [], + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 46, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L46" + "lineNumber": 73, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73" } }, { "tags": [], - "id": "def-server.SavedObjectReference.id", + "id": "def-server.SavedObject.version", "type": "string", - "label": "id", - "description": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 47, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L47" - } - } - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L44" - }, - "initialIsOpen": false - }, - { - "id": "def-server.SavedObjectsMigrationVersion", - "type": "Interface", - "label": "SavedObjectsMigrationVersion", - "description": [ - "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" - ], - "tags": [ - "example", - "public" - ], - "children": [ + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75" + }, + "signature": [ + "string | undefined" + ] + }, { - "id": "def-server.SavedObjectsMigrationVersion.Unnamed", - "type": "Any", - "label": "Unnamed", "tags": [], - "description": [], + "id": "def-server.SavedObject.updated_at", + "type": "string", + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], "source": { "path": "src/core/types/saved_objects.ts", - "lineNumber": 66, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L66" + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77" }, "signature": [ - "any" + "string | undefined" ] - } - ], - "source": { - "path": "src/core/types/saved_objects.ts", - "lineNumber": 65, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L65" - }, - "initialIsOpen": false - }, - { - "id": "def-server.LegacyServiceSetupDeps", - "type": "Interface", - "label": "LegacyServiceSetupDeps", - "description": [], - "tags": [ - "public", - "deprecated" - ], - "children": [ + }, { "tags": [], - "id": "def-server.LegacyServiceSetupDeps.core", - "type": "CompoundType", - "label": "core", + "id": "def-server.SavedObject.error", + "type": "Object", + "label": "error", "description": [], "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L43" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 78, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78" + }, + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + " | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 80, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80" }, "signature": [ - "LegacyCoreSetup" + "T" ] }, { "tags": [], - "id": "def-server.LegacyServiceSetupDeps.plugins", - "type": "Object", - "label": "plugins", - "description": [], + "id": "def-server.SavedObject.references", + "type": "Array", + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 44, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L44" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 82, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82" }, "signature": [ - "Record" + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" ] }, { "tags": [], - "id": "def-server.LegacyServiceSetupDeps.uiPlugins", + "id": "def-server.SavedObject.migrationVersion", "type": "Object", - "label": "uiPlugins", - "description": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 45, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L45" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 84, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84" }, "signature": [ { "pluginId": "core", - "scope": "server", + "scope": "common", "docId": "kibCorePluginApi", - "section": "def-server.UiPlugins", - "text": "UiPlugins" - } + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" ] - } - ], - "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 42, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L42" - }, - "initialIsOpen": false - }, - { - "id": "def-server.LegacyServiceStartDeps", - "type": "Interface", - "label": "LegacyServiceStartDeps", - "description": [], - "tags": [ - "public", - "deprecated" - ], - "children": [ + }, { "tags": [], - "id": "def-server.LegacyServiceStartDeps.core", - "type": "CompoundType", - "label": "core", - "description": [], + "id": "def-server.SavedObject.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 53, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L53" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86" }, "signature": [ - "LegacyCoreStart" + "string | undefined" ] }, { "tags": [], - "id": "def-server.LegacyServiceStartDeps.plugins", - "type": "Object", - "label": "plugins", - "description": [], + "id": "def-server.SavedObject.namespaces", + "type": "Array", + "label": "namespaces", + "description": [ + "Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types." + ], "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L54" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 88, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88" }, "signature": [ - "Record" + "string[] | undefined" + ] + }, + { + "tags": [], + "id": "def-server.SavedObject.originId", + "type": "string", + "label": "originId", + "description": [ + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 95, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95" + }, + "signature": [ + "string | undefined" ] } ], "source": { - "path": "src/core/server/legacy/types.ts", - "lineNumber": 52, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L52" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 69, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69" }, "initialIsOpen": false }, { - "id": "def-server.CoreStatus", + "id": "def-server.SavedObjectAttributes", "type": "Interface", - "label": "CoreStatus", + "label": "SavedObjectAttributes", "description": [ - "\nStatus of core services.\n" + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], "tags": [ - "internalRemarks", "public" ], "children": [ { + "id": "def-server.SavedObjectAttributes.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "id": "def-server.CoreStatus.elasticsearch", - "type": "Object", - "label": "elasticsearch", - "description": [], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 115, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L115" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - "" - ] - }, - { - "tags": [], - "id": "def-server.CoreStatus.savedObjects", - "type": "Object", - "label": "savedObjects", "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 116, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L116" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L36" }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - "" + "any" ] } ], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 114, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L114" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L35" }, "initialIsOpen": false }, { - "id": "def-server.ServiceStatus", + "id": "def-server.SavedObjectReference", "type": "Interface", - "label": "ServiceStatus", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - "" - ], + "label": "SavedObjectReference", "description": [ - "\nThe current status of a service at a point in time.\n" + "\nA reference to another saved object.\n" ], "tags": [ - "typeParam", "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.ServiceStatus.level", - "type": "CompoundType", - "label": "level", - "description": [ - "\nThe current availability level of the service." - ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L24" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatusLevel", - "text": "ServiceStatusLevel" - } - ] - }, - { - "tags": [], - "id": "def-server.ServiceStatus.summary", - "type": "string", - "label": "summary", - "description": [ - "\nA high-level summary of the service status." - ], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L28" - } - }, + ], + "children": [ { "tags": [], - "id": "def-server.ServiceStatus.detail", + "id": "def-server.SavedObjectReference.name", "type": "string", - "label": "detail", - "description": [ - "\nA more detailed description of the service status." - ], + "label": "name", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L32" - }, - "signature": [ - "string | undefined" - ] + "path": "src/core/types/saved_objects.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L45" + } }, { "tags": [], - "id": "def-server.ServiceStatus.documentationUrl", + "id": "def-server.SavedObjectReference.type", "type": "string", - "label": "documentationUrl", - "description": [ - "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." - ], + "label": "type", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L36" - }, - "signature": [ - "string | undefined" - ] + "path": "src/core/types/saved_objects.ts", + "lineNumber": 46, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L46" + } }, { "tags": [], - "id": "def-server.ServiceStatus.meta", - "type": "Uncategorized", - "label": "meta", - "description": [ - "\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features." - ], + "id": "def-server.SavedObjectReference.id", + "type": "string", + "label": "id", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 41, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L41" - }, - "signature": [ - "Meta | undefined" - ] + "path": "src/core/types/saved_objects.ts", + "lineNumber": 47, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L47" + } } ], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 20, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L20" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L44" }, "initialIsOpen": false }, { - "id": "def-server.StatusServiceSetup", + "id": "def-server.SavedObjectsMigrationVersion", "type": "Interface", - "label": "StatusServiceSetup", + "label": "SavedObjectsMigrationVersion", "description": [ - "\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n" + "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" ], "tags": [ - "remarks", - "example", "example", "public" ], "children": [ { + "id": "def-server.SavedObjectsMigrationVersion.Unnamed", + "type": "Any", + "label": "Unnamed", "tags": [], - "id": "def-server.StatusServiceSetup.core$", - "type": "Object", - "label": "core$", - "description": [ - "\nCurrent status for all Core services." - ], + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 181, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L181" + "path": "src/core/types/saved_objects.ts", + "lineNumber": 66, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L66" }, "signature": [ - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStatus", - "text": "CoreStatus" - }, - ">" + "any" ] - }, + } + ], + "source": { + "path": "src/core/types/saved_objects.ts", + "lineNumber": 65, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L65" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyServiceSetupDeps", + "type": "Interface", + "label": "LegacyServiceSetupDeps", + "description": [], + "tags": [ + "public", + "deprecated" + ], + "children": [ { - "tags": [ - "remarks" - ], - "id": "def-server.StatusServiceSetup.overall$", - "type": "Object", - "label": "overall$", - "description": [ - "\nOverall system status for all of Kibana.\n" - ], + "tags": [], + "id": "def-server.LegacyServiceSetupDeps.core", + "type": "CompoundType", + "label": "core", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 192, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L192" + "path": "src/core/server/legacy/types.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L43" }, "signature": [ - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - ">" + "LegacyCoreSetup" ] }, { - "id": "def-server.StatusServiceSetup.set", - "type": "Function", - "label": "set", - "signature": [ - "(status$: ", - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - ">) => void" - ], - "description": [ - "\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n" - ], - "children": [ - { - "type": "Object", - "label": "status$", - "isRequired": true, - "signature": [ - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - ">" - ], - "description": [], - "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 202, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202" - } - } - ], - "tags": [ - "remarks" - ], - "returnComment": [], + "tags": [], + "id": "def-server.LegacyServiceSetupDeps.plugins", + "type": "Object", + "label": "plugins", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 202, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202" - } + "path": "src/core/server/legacy/types.ts", + "lineNumber": 44, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L44" + }, + "signature": [ + "Record" + ] }, { "tags": [], - "id": "def-server.StatusServiceSetup.dependencies$", + "id": "def-server.LegacyServiceSetupDeps.uiPlugins", "type": "Object", - "label": "dependencies$", - "description": [ - "\nCurrent status for all plugins this plugin depends on.\nEach key of the `Record` is a plugin id." - ], + "label": "uiPlugins", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 208, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L208" + "path": "src/core/server/legacy/types.ts", + "lineNumber": 45, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L45" }, "signature": [ - "Observable", - ">>" + "section": "def-server.UiPlugins", + "text": "UiPlugins" + } ] - }, + } + ], + "source": { + "path": "src/core/server/legacy/types.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L42" + }, + "initialIsOpen": false + }, + { + "id": "def-server.LegacyServiceStartDeps", + "type": "Interface", + "label": "LegacyServiceStartDeps", + "description": [], + "tags": [ + "public", + "deprecated" + ], + "children": [ { - "tags": [ - "remarks" - ], - "id": "def-server.StatusServiceSetup.derivedStatus$", - "type": "Object", - "label": "derivedStatus$", - "description": [ - "\nThe status of this plugin as derived from its dependencies.\n" - ], + "tags": [], + "id": "def-server.LegacyServiceStartDeps.core", + "type": "CompoundType", + "label": "core", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 220, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L220" + "path": "src/core/server/legacy/types.ts", + "lineNumber": 53, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L53" }, "signature": [ - "Observable", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - ">" + "LegacyCoreStart" ] }, { "tags": [], - "id": "def-server.StatusServiceSetup.isStatusPageAnonymous", - "type": "Function", - "label": "isStatusPageAnonymous", - "description": [ - "\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent." - ], + "id": "def-server.LegacyServiceStartDeps.plugins", + "type": "Object", + "label": "plugins", + "description": [], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 226, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L226" + "path": "src/core/server/legacy/types.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L54" }, "signature": [ - "() => boolean" + "Record" ] } ], "source": { - "path": "src/core/server/status/types.ts", - "lineNumber": 177, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L177" + "path": "src/core/server/legacy/types.ts", + "lineNumber": 52, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L52" }, "initialIsOpen": false }, { - "id": "def-server.RequestHandlerContext", + "id": "def-server.CoreStatus", "type": "Interface", - "label": "RequestHandlerContext", + "label": "CoreStatus", "description": [ - "\nPlugin specific context passed to a route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link LegacyScopedClusterClient | elasticsearch.legacy.client} - The legacy Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request\n" + "\nStatus of core services.\n" ], "tags": [ + "internalRemarks", "public" ], "children": [ { "tags": [], - "id": "def-server.RequestHandlerContext.core", + "id": "def-server.CoreStatus.elasticsearch", "type": "Object", - "label": "core", + "label": "elasticsearch", "description": [], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 415, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L415" + "path": "src/core/server/status/types.ts", + "lineNumber": 115, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L115" }, "signature": [ - "{ savedObjects: { client: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; typeRegistry: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeRegistry", - "text": "SavedObjectTypeRegistry" - }, - ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; getClient: (options?: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" }, - " | undefined) => Pick<", + "" + ] + }, + { + "tags": [], + "id": "def-server.CoreStatus.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L116" + }, + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; getExporter: (client: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - } + "" ] } ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 414, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L414" + "path": "src/core/server/status/types.ts", + "lineNumber": 114, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L114" }, "initialIsOpen": false }, { - "id": "def-server.CoreSetup", + "id": "def-server.ServiceStatus", "type": "Interface", - "label": "CoreSetup", + "label": "ServiceStatus", "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" }, - "" + "" ], "description": [ - "\nContext passed to the plugins `setup` method.\n" + "\nThe current status of a service at a point in time.\n" ], "tags": [ - "typeParam", "typeParam", "public" ], "children": [ { "tags": [], - "id": "def-server.CoreSetup.capabilities", - "type": "Object", - "label": "capabilities", + "id": "def-server.ServiceStatus.level", + "type": "CompoundType", + "label": "level", "description": [ - "{@link CapabilitiesSetup}" + "\nThe current availability level of the service." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 449, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L449" + "path": "src/core/server/status/types.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L24" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSetup", - "text": "CapabilitiesSetup" + "section": "def-server.ServiceStatusLevel", + "text": "ServiceStatusLevel" } ] }, { "tags": [], - "id": "def-server.CoreSetup.context", - "type": "Object", - "label": "context", + "id": "def-server.ServiceStatus.summary", + "type": "string", + "label": "summary", "description": [ - "{@link ContextSetup}" + "\nA high-level summary of the service status." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 451, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L451" + "path": "src/core/server/status/types.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L28" + } + }, + { + "tags": [], + "id": "def-server.ServiceStatus.detail", + "type": "string", + "label": "detail", + "description": [ + "\nA more detailed description of the service status." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L32" }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ContextSetup", - "text": "ContextSetup" - } + "string | undefined" ] }, { "tags": [], - "id": "def-server.CoreSetup.elasticsearch", - "type": "Object", - "label": "elasticsearch", + "id": "def-server.ServiceStatus.documentationUrl", + "type": "string", + "label": "documentationUrl", "description": [ - "{@link ElasticsearchServiceSetup}" + "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 453, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L453" + "path": "src/core/server/status/types.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L36" }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceSetup", - "text": "ElasticsearchServiceSetup" - } + "string | undefined" ] }, { "tags": [], - "id": "def-server.CoreSetup.http", - "type": "CompoundType", - "label": "http", + "id": "def-server.ServiceStatus.meta", + "type": "Uncategorized", + "label": "meta", + "description": [ + "\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features." + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 41, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L41" + }, + "signature": [ + "Meta | undefined" + ] + } + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 20, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L20" + }, + "initialIsOpen": false + }, + { + "id": "def-server.StatusServiceSetup", + "type": "Interface", + "label": "StatusServiceSetup", + "description": [ + "\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n" + ], + "tags": [ + "remarks", + "example", + "example", + "public" + ], + "children": [ + { + "tags": [], + "id": "def-server.StatusServiceSetup.core$", + "type": "Object", + "label": "core$", "description": [ - "{@link HttpServiceSetup}" + "\nCurrent status for all Core services." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 455, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L455" + "path": "src/core/server/status/types.ts", + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L181" }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceSetup", - "text": "HttpServiceSetup" - }, - " & { resources: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.HttpResources", - "text": "HttpResources" + "section": "def-server.CoreStatus", + "text": "CoreStatus" }, - "; }" + ">" ] }, { - "tags": [], - "id": "def-server.CoreSetup.i18n", + "tags": [ + "remarks" + ], + "id": "def-server.StatusServiceSetup.overall$", "type": "Object", - "label": "i18n", + "label": "overall$", "description": [ - "{@link I18nServiceSetup}" + "\nOverall system status for all of Kibana.\n" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 460, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L460" + "path": "src/core/server/status/types.ts", + "lineNumber": 192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L192" }, "signature": [ + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.I18nServiceSetup", - "text": "I18nServiceSetup" - } + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">" ] }, { - "tags": [], - "id": "def-server.CoreSetup.logging", - "type": "Object", - "label": "logging", - "description": [ - "{@link LoggingServiceSetup}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 462, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L462" - }, + "id": "def-server.StatusServiceSetup.set", + "type": "Function", + "label": "set", "signature": [ + "(status$: ", + "Observable", + "<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.LoggingServiceSetup", - "text": "LoggingServiceSetup" + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">) => void" + ], + "description": [ + "\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n" + ], + "children": [ + { + "type": "Object", + "label": "status$", + "isRequired": true, + "signature": [ + "Observable", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">" + ], + "description": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202" + } } - ] + ], + "tags": [ + "remarks" + ], + "returnComment": [], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 202, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202" + } }, { "tags": [], - "id": "def-server.CoreSetup.metrics", + "id": "def-server.StatusServiceSetup.dependencies$", "type": "Object", - "label": "metrics", + "label": "dependencies$", "description": [ - "{@link MetricsServiceSetup}" + "\nCurrent status for all plugins this plugin depends on.\nEach key of the `Record` is a plugin id." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 464, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L464" + "path": "src/core/server/status/types.ts", + "lineNumber": 208, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L208" }, "signature": [ + "Observable", + ">>" ] }, { - "tags": [], - "id": "def-server.CoreSetup.savedObjects", + "tags": [ + "remarks" + ], + "id": "def-server.StatusServiceSetup.derivedStatus$", "type": "Object", - "label": "savedObjects", + "label": "derivedStatus$", "description": [ - "{@link SavedObjectsServiceSetup}" + "\nThe status of this plugin as derived from its dependencies.\n" ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 466, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L466" + "path": "src/core/server/status/types.ts", + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L220" }, "signature": [ + "Observable", + "<", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceSetup", - "text": "SavedObjectsServiceSetup" - } + "docId": "kibCorePluginApi", + "section": "def-server.ServiceStatus", + "text": "ServiceStatus" + }, + ">" ] }, { "tags": [], - "id": "def-server.CoreSetup.status", - "type": "Object", - "label": "status", + "id": "def-server.StatusServiceSetup.isStatusPageAnonymous", + "type": "Function", + "label": "isStatusPageAnonymous", "description": [ - "{@link StatusServiceSetup}" + "\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent." ], "source": { - "path": "src/core/server/index.ts", - "lineNumber": 468, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L468" + "path": "src/core/server/status/types.ts", + "lineNumber": 226, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L226" }, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StatusServiceSetup", - "text": "StatusServiceSetup" - } + "() => boolean" ] - }, + } + ], + "source": { + "path": "src/core/server/status/types.ts", + "lineNumber": 177, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L177" + }, + "initialIsOpen": false + }, + { + "id": "def-server.RequestHandlerContext", + "type": "Interface", + "label": "RequestHandlerContext", + "description": [ + "\nPlugin specific context passed to a route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link LegacyScopedClusterClient | elasticsearch.legacy.client} - The legacy Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request\n" + ], + "tags": [ + "public" + ], + "children": [ { "tags": [], - "id": "def-server.CoreSetup.uiSettings", + "id": "def-server.RequestHandlerContext.core", "type": "Object", - "label": "uiSettings", - "description": [ - "{@link UiSettingsServiceSetup}" - ], + "label": "core", + "description": [], "source": { "path": "src/core/server/index.ts", - "lineNumber": 470, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L470" + "lineNumber": 425, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L425" }, "signature": [ + "{ savedObjects: { client: Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceSetup", - "text": "UiSettingsServiceSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreSetup.getStartServices", - "type": "Function", - "label": "getStartServices", - "description": [ - "{@link StartServicesAccessor}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 472, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L472" - }, - "signature": [ + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; typeRegistry: Pick<", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StartServicesAccessor", - "text": "StartServicesAccessor" + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeRegistry", + "text": "SavedObjectTypeRegistry" }, - "" + ", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; getClient: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; getExporter: (client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + } ] } ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 447, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L447" + "lineNumber": 424, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L424" }, "initialIsOpen": false }, { - "id": "def-server.CoreStart", + "id": "def-server.CoreSetup", "type": "Interface", - "label": "CoreStart", + "label": "CoreSetup", + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], "description": [ - "\nContext passed to the plugins `start` method.\n" + "\nContext passed to the plugins `setup` method.\n" ], "tags": [ + "typeParam", + "typeParam", "public" ], "children": [ { "tags": [], - "id": "def-server.CoreStart.capabilities", + "id": "def-server.CoreSetup.capabilities", "type": "Object", "label": "capabilities", "description": [ - "{@link CapabilitiesStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 495, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L495" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreStart.elasticsearch", - "type": "Object", - "label": "elasticsearch", - "description": [ - "{@link ElasticsearchServiceStart}" + "{@link CapabilitiesSetup}" ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 497, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L497" + "lineNumber": 459, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L459" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchServiceStart", - "text": "ElasticsearchServiceStart" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreStart.http", - "type": "Object", - "label": "http", - "description": [ - "{@link HttpServiceStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 499, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L499" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpServiceStart", - "text": "HttpServiceStart" + "section": "def-server.CapabilitiesSetup", + "text": "CapabilitiesSetup" } ] }, { "tags": [], - "id": "def-server.CoreStart.metrics", + "id": "def-server.CoreSetup.context", "type": "Object", - "label": "metrics", + "label": "context", "description": [ - "{@link MetricsServiceStart}" + "{@link ContextSetup}" ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 501, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L501" + "lineNumber": 461, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L461" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } - ] - }, - { - "tags": [], - "id": "def-server.CoreStart.savedObjects", - "type": "Object", - "label": "savedObjects", - "description": [ - "{@link SavedObjectsServiceStart}" - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 503, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L503" - }, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsServiceStart", - "text": "SavedObjectsServiceStart" + "section": "def-server.ContextSetup", + "text": "ContextSetup" } ] }, { "tags": [], - "id": "def-server.CoreStart.uiSettings", + "id": "def-server.CoreSetup.elasticsearch", "type": "Object", - "label": "uiSettings", + "label": "elasticsearch", "description": [ - "{@link UiSettingsServiceStart}" + "{@link ElasticsearchServiceSetup}" ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 505, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L505" + "lineNumber": 463, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L463" }, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" - } - ] - } - ], - "source": { - "path": "src/core/server/index.ts", - "lineNumber": 493, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L493" - }, - "initialIsOpen": false - }, - { - "id": "def-server.CapabilitiesSetup", - "type": "Interface", - "label": "CapabilitiesSetup", - "description": [ - "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" - ], - "tags": [ - "public" - ], - "children": [ - { - "id": "def-server.CapabilitiesSetup.registerProvider", - "type": "Function", - "label": "registerProvider", - "signature": [ - "(provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - }, - ") => void" - ], - "description": [ - "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" - ], - "children": [ - { - "type": "Function", - "label": "provider", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - } - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54" - } - } - ], - "tags": [ - "example" - ], - "returnComment": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54" - } - }, - { - "id": "def-server.CapabilitiesSetup.registerSwitcher", - "type": "Function", - "label": "registerSwitcher", - "signature": [ - "(switcher: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - }, - ") => void" - ], - "description": [ - "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" - ], - "children": [ - { - "type": "Function", - "label": "switcher", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - } - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 93, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93" - } + "section": "def-server.ElasticsearchServiceSetup", + "text": "ElasticsearchServiceSetup" } - ], - "tags": [ - "example" - ], - "returnComment": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 93, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93" - } - } - ], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L30" - }, - "initialIsOpen": false - }, - { - "id": "def-server.CapabilitiesStart", - "type": "Interface", - "label": "CapabilitiesStart", - "description": [ - "\nAPIs to access the application {@link Capabilities}.\n" - ], - "tags": [ - "public" - ], - "children": [ + ] + }, { - "id": "def-server.CapabilitiesStart.resolveCapabilities", - "type": "Function", - "label": "resolveCapabilities", + "tags": [], + "id": "def-server.CoreSetup.http", + "type": "CompoundType", + "label": "http", + "description": [ + "{@link HttpServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 465, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L465" + }, "signature": [ - "(request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.HttpServiceSetup", + "text": "HttpServiceSetup" }, - ", options?: ", + " & { resources: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" + "section": "def-server.HttpResources", + "text": "HttpResources" }, - " | undefined) => Promise<", + "; }" + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.i18n", + "type": "Object", + "label": "i18n", + "description": [ + "{@link I18nServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 470, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L470" + }, + "signature": [ { "pluginId": "core", - "scope": "common", + "scope": "server", "docId": "kibCorePluginApi", - "section": "def-common.Capabilities", - "text": "Capabilities" - }, - ">" - ], + "section": "def-server.I18nServiceSetup", + "text": "I18nServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.logging", + "type": "Object", + "label": "logging", "description": [ - "\nResolve the {@link Capabilities} to be used for given request" + "{@link LoggingServiceSetup}" ], - "children": [ - { - "type": "Object", - "label": "request", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "" - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L118" - } - }, + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 472, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L472" + }, + "signature": [ { - "type": "Object", - "label": "options", - "isRequired": false, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, - " | undefined" - ], - "description": [], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 119, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L119" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.LoggingServiceSetup", + "text": "LoggingServiceSetup" } - ], + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-server.CoreSetup.metrics", + "type": "Object", + "label": "metrics", + "description": [ + "{@link MetricsServiceSetup}" + ], "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L117" - } - } - ], - "source": { - "path": "src/core/server/capabilities/capabilities_service.ts", - "lineNumber": 113, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L113" - }, - "initialIsOpen": false - }, - { - "id": "def-server.ContextSetup", - "type": "Interface", - "label": "ContextSetup", - "description": [ - "\n{@inheritdoc IContextContainer}\n" - ], - "tags": [ - "example", - "public" - ], - "children": [ - { - "id": "def-server.ContextSetup.createContextContainer", - "type": "Function", - "label": "createContextContainer", + "path": "src/core/server/index.ts", + "lineNumber": 474, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L474" + }, "signature": [ - ">() => ", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceSetup}" + ], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 476, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L476" + }, + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IContextContainer", - "text": "IContextContainer" - }, - "" - ], + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceSetup", + "text": "SavedObjectsServiceSetup" + } + ] + }, + { + "tags": [], + "id": "def-server.CoreSetup.status", + "type": "Object", + "label": "status", "description": [ - "\nCreates a new {@link IContextContainer} for a service owner." + "{@link StatusServiceSetup}" ], - "children": [], + "source": { + "path": "src/core/server/index.ts", + "lineNumber": 478, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L478" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.StatusServiceSetup", + "text": "StatusServiceSetup" + } + ] + }, + { "tags": [], - "returnComment": [], + "id": "def-server.CoreSetup.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceSetup}" + ], "source": { - "path": "src/core/server/context/context_service.ts", - "lineNumber": 96, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L96" - } - } - ], - "source": { - "path": "src/core/server/context/context_service.ts", - "lineNumber": 92, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L92" - }, - "initialIsOpen": false - }, - { - "id": "def-server.HttpResources", - "type": "Interface", - "label": "HttpResources", - "description": [ - "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." - ], - "tags": [ - "public" - ], - "children": [ + "path": "src/core/server/index.ts", + "lineNumber": 480, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L480" + }, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceSetup", + "text": "UiSettingsServiceSetup" + } + ] + }, { "tags": [], - "id": "def-server.HttpResources.register", + "id": "def-server.CoreSetup.getStartServices", "type": "Function", - "label": "register", + "label": "getStartServices", "description": [ - "To register a route handler executing passed function to form response." + "{@link StartServicesAccessor}" ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L101" + "path": "src/core/server/index.ts", + "lineNumber": 482, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L482" }, "signature": [ - "(route: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteConfig", - "text": "RouteConfig" - }, - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RequestHandler", - "text": "RequestHandler" + "section": "def-server.StartServicesAccessor", + "text": "StartServicesAccessor" }, - " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream" + "" ] } ], "source": { - "path": "src/core/server/http_resources/types.ts", - "lineNumber": 99, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L99" + "path": "src/core/server/index.ts", + "lineNumber": 457, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L457" }, "initialIsOpen": false }, { - "id": "def-server.LegacyCallAPIOptions", + "id": "def-server.CoreStart", "type": "Interface", - "label": "LegacyCallAPIOptions", + "label": "CoreStart", "description": [ - "\nThe set of options that defines how API call should be made and result be\nprocessed.\n" + "\nContext passed to the plugins `start` method.\n" ], "tags": [ - "public", - "deprecated" + "public" ], "children": [ { "tags": [], - "id": "def-server.LegacyCallAPIOptions.wrap401Errors", - "type": "CompoundType", - "label": "wrap401Errors", + "id": "def-server.CoreStart.capabilities", + "type": "Object", + "label": "capabilities", "description": [ - "\nIndicates whether `401 Unauthorized` errors returned from the Elasticsearch API\nshould be wrapped into `Boom` error instances with properly set `WWW-Authenticate`\nheader that could have been returned by the API itself. If API didn't specify that\nthen `Basic realm=\"Authorization Required\"` is used as `WWW-Authenticate`." + "{@link CapabilitiesStart}" ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 151, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L151" + "path": "src/core/server/index.ts", + "lineNumber": 505, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L505" }, "signature": [ - "boolean | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesStart", + "text": "CapabilitiesStart" + } ] }, { "tags": [], - "id": "def-server.LegacyCallAPIOptions.signal", + "id": "def-server.CoreStart.elasticsearch", "type": "Object", - "label": "signal", + "label": "elasticsearch", "description": [ - "\nA signal object that allows you to abort the request via an AbortController object." + "{@link ElasticsearchServiceStart}" ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 155, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L155" + "path": "src/core/server/index.ts", + "lineNumber": 507, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L507" }, "signature": [ - "AbortSignal | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchServiceStart", + "text": "ElasticsearchServiceStart" + } ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 144, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L144" - }, - "initialIsOpen": false - }, - { - "id": "def-server.AssistantAPIClientParams", - "type": "Interface", - "label": "AssistantAPIClientParams", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.AssistantAPIClientParams", - "text": "AssistantAPIClientParams" }, - " extends ", - "GenericParams" - ], - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ { "tags": [], - "id": "def-server.AssistantAPIClientParams.path", - "type": "string", - "label": "path", - "description": [], + "id": "def-server.CoreStart.http", + "type": "Object", + "label": "http", + "description": [ + "{@link HttpServiceStart}" + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 318, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L318" + "path": "src/core/server/index.ts", + "lineNumber": 509, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L509" }, "signature": [ - "\"/_migration/assistance\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpServiceStart", + "text": "HttpServiceStart" + } ] }, { "tags": [], - "id": "def-server.AssistantAPIClientParams.method", - "type": "string", - "label": "method", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 319, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L319" - }, - "signature": [ - "\"GET\"" - ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 317, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L317" - }, - "initialIsOpen": false - }, - { - "id": "def-server.AssistanceAPIResponse", - "type": "Interface", - "label": "AssistanceAPIResponse", - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ - { - "tags": [], - "id": "def-server.AssistanceAPIResponse.indices", + "id": "def-server.CoreStart.metrics", "type": "Object", - "label": "indices", - "description": [], + "label": "metrics", + "description": [ + "{@link MetricsServiceStart}" + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 338, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L338" + "path": "src/core/server/index.ts", + "lineNumber": 511, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L511" }, "signature": [ - "{ [indexName: string]: { action_required: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", - "text": "MIGRATION_ASSISTANCE_INDEX_ACTION" - }, - "; }; }" + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } ] - } - ], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 337, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L337" - }, - "initialIsOpen": false - }, - { - "id": "def-server.DeprecationAPIClientParams", - "type": "Interface", - "label": "DeprecationAPIClientParams", - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationAPIClientParams", - "text": "DeprecationAPIClientParams" }, - " extends ", - "GenericParams" - ], - "description": [], - "tags": [ - "deprecated", - "public" - ], - "children": [ { "tags": [], - "id": "def-server.DeprecationAPIClientParams.path", - "type": "string", - "label": "path", - "description": [], + "id": "def-server.CoreStart.savedObjects", + "type": "Object", + "label": "savedObjects", + "description": [ + "{@link SavedObjectsServiceStart}" + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 350, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L350" + "path": "src/core/server/index.ts", + "lineNumber": 513, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L513" }, "signature": [ - "\"/_migration/deprecations\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceStart", + "text": "SavedObjectsServiceStart" + } ] }, - { - "tags": [], - "id": "def-server.DeprecationAPIClientParams.method", - "type": "string", - "label": "method", - "description": [], + { + "tags": [], + "id": "def-server.CoreStart.uiSettings", + "type": "Object", + "label": "uiSettings", + "description": [ + "{@link UiSettingsServiceStart}" + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 351, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L351" + "path": "src/core/server/index.ts", + "lineNumber": 515, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L515" }, "signature": [ - "\"GET\"" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.UiSettingsServiceStart", + "text": "UiSettingsServiceStart" + } ] } ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 349, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L349" + "path": "src/core/server/index.ts", + "lineNumber": 503, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L503" }, "initialIsOpen": false }, { - "id": "def-server.DeprecationInfo", + "id": "def-server.CapabilitiesSetup", "type": "Interface", - "label": "DeprecationInfo", - "description": [], + "label": "CapabilitiesSetup", + "description": [ + "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" + ], "tags": [ - "deprecated", "public" ], "children": [ { - "tags": [], - "id": "def-server.DeprecationInfo.level", - "type": "CompoundType", - "label": "level", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 359, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L359" - }, + "id": "def-server.CapabilitiesSetup.registerProvider", + "type": "Function", + "label": "registerProvider", "signature": [ + "(provider: ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.MIGRATION_DEPRECATION_LEVEL", - "text": "MIGRATION_DEPRECATION_LEVEL" + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + }, + ") => void" + ], + "description": [ + "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" + ], + "children": [ + { + "type": "Function", + "label": "provider", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + } + ], + "description": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54" + } } - ] - }, - { - "tags": [], - "id": "def-server.DeprecationInfo.message", - "type": "string", - "label": "message", - "description": [], + ], + "tags": [ + "example" + ], + "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 360, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L360" + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54" } }, { - "tags": [], - "id": "def-server.DeprecationInfo.url", - "type": "string", - "label": "url", - "description": [], + "id": "def-server.CapabilitiesSetup.registerSwitcher", + "type": "Function", + "label": "registerSwitcher", + "signature": [ + "(switcher: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + }, + ") => void" + ], + "description": [ + "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" + ], + "children": [ + { + "type": "Function", + "label": "switcher", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + } + ], + "description": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93" + } + } + ], + "tags": [ + "example" + ], + "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 361, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L361" + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 93, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93" } - }, + } + ], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L30" + }, + "initialIsOpen": false + }, + { + "id": "def-server.CapabilitiesStart", + "type": "Interface", + "label": "CapabilitiesStart", + "description": [ + "\nAPIs to access the application {@link Capabilities}.\n" + ], + "tags": [ + "public" + ], + "children": [ { - "tags": [], - "id": "def-server.DeprecationInfo.details", - "type": "string", - "label": "details", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 362, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L362" - }, + "id": "def-server.CapabilitiesStart.resolveCapabilities", + "type": "Function", + "label": "resolveCapabilities", "signature": [ - "string | undefined" - ] + "(request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.Capabilities", + "text": "Capabilities" + }, + ">" + ], + "description": [ + "\nResolve the {@link Capabilities} to be used for given request" + ], + "children": [ + { + "type": "Object", + "label": "request", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "description": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L118" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L119" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L117" + } } ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 358, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L358" + "path": "src/core/server/capabilities/capabilities_service.ts", + "lineNumber": 113, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L113" }, "initialIsOpen": false }, { - "id": "def-server.IndexSettingsDeprecationInfo", + "id": "def-server.ContextSetup", "type": "Interface", - "label": "IndexSettingsDeprecationInfo", - "description": [], + "label": "ContextSetup", + "description": [ + "\n{@inheritdoc IContextContainer}\n" + ], "tags": [ - "deprecated", + "example", "public" ], "children": [ { - "id": "def-server.IndexSettingsDeprecationInfo.Unnamed", - "type": "Any", - "label": "Unnamed", + "id": "def-server.ContextSetup.createContextContainer", + "type": "Function", + "label": "createContextContainer", + "signature": [ + ">() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IContextContainer", + "text": "IContextContainer" + }, + "" + ], + "description": [ + "\nCreates a new {@link IContextContainer} for a service owner." + ], + "children": [], "tags": [], - "description": [], + "returnComment": [], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 370, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L370" - }, - "signature": [ - "any" - ] + "path": "src/core/server/context/context_service.ts", + "lineNumber": 96, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L96" + } } ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 369, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L369" + "path": "src/core/server/context/context_service.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L92" }, "initialIsOpen": false }, { - "id": "def-server.DeprecationAPIResponse", + "id": "def-server.HttpResources", "type": "Interface", - "label": "DeprecationAPIResponse", - "description": [], + "label": "HttpResources", + "description": [ + "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." + ], "tags": [ - "deprecated", "public" ], "children": [ { "tags": [], - "id": "def-server.DeprecationAPIResponse.cluster_settings", - "type": "Array", - "label": "cluster_settings", - "description": [], + "id": "def-server.HttpResources.register", + "type": "Function", + "label": "register", + "description": [ + "To register a route handler executing passed function to form response." + ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 378, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L378" + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L101" }, "signature": [ + "(route: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationInfo", - "text": "DeprecationInfo" + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" }, - "[]" - ] - }, - { - "tags": [], - "id": "def-server.DeprecationAPIResponse.index_settings", - "type": "Object", - "label": "index_settings", - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 381, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L381" - }, - "signature": [ + ", handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IndexSettingsDeprecationInfo", - "text": "IndexSettingsDeprecationInfo" - } + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RequestHandler", + "text": "RequestHandler" + }, + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream" ] } ], "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 377, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L377" + "path": "src/core/server/http_resources/types.ts", + "lineNumber": 99, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L99" }, "initialIsOpen": false } @@ -17267,6 +17204,44 @@ ], "initialIsOpen": false }, + { + "id": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", + "type": "Type", + "label": "MIGRATION_ASSISTANCE_INDEX_ACTION", + "tags": [ + "deprecated", + "public" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 326, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L326" + }, + "signature": [ + "\"upgrade\" | \"reindex\"" + ], + "initialIsOpen": false + }, + { + "id": "def-server.MIGRATION_DEPRECATION_LEVEL", + "type": "Type", + "label": "MIGRATION_DEPRECATION_LEVEL", + "tags": [ + "deprecated", + "public" + ], + "description": [], + "source": { + "path": "src/core/server/elasticsearch/legacy/api_types.ts", + "lineNumber": 331, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L331" + }, + "signature": [ + "\"warning\" | \"none\" | \"info\" | \"critical\"" + ], + "initialIsOpen": false + }, { "id": "def-server.HttpResourcesResponseOptions", "type": "Type", @@ -17639,7 +17614,7 @@ "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L103" }, "signature": [ - "Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>" + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" ], "initialIsOpen": false }, @@ -17655,8 +17630,8 @@ ], "source": { "path": "src/core/server/index.ts", - "lineNumber": 483, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L483" + "lineNumber": 493, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L493" }, "signature": [ "() => Promise<[", @@ -17688,44 +17663,6 @@ "symbol" ], "initialIsOpen": false - }, - { - "id": "def-server.MIGRATION_ASSISTANCE_INDEX_ACTION", - "type": "Type", - "label": "MIGRATION_ASSISTANCE_INDEX_ACTION", - "tags": [ - "deprecated", - "public" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 326, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L326" - }, - "signature": [ - "\"upgrade\" | \"reindex\"" - ], - "initialIsOpen": false - }, - { - "id": "def-server.MIGRATION_DEPRECATION_LEVEL", - "type": "Type", - "label": "MIGRATION_DEPRECATION_LEVEL", - "tags": [ - "deprecated", - "public" - ], - "description": [], - "source": { - "path": "src/core/server/elasticsearch/legacy/api_types.ts", - "lineNumber": 331, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L331" - }, - "signature": [ - "\"warning\" | \"none\" | \"info\" | \"critical\"" - ], - "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/core_application.json b/api_docs/core_application.json index 17efa538b3122..c6aa4cfde1b50 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -1652,19 +1652,19 @@ ], "enums": [ { - "id": "def-public.AppLeaveActionType", + "id": "def-public.AppNavLinkStatus", "type": "Enum", - "label": "AppLeaveActionType", + "label": "AppNavLinkStatus", "tags": [ "public" ], "description": [ - "\nPossible type of actions on application leave.\n" + "\nStatus of the application's navLink.\n" ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 540, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L540" + "lineNumber": 40, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L40" }, "initialIsOpen": false }, @@ -1686,19 +1686,19 @@ "initialIsOpen": false }, { - "id": "def-public.AppNavLinkStatus", + "id": "def-public.AppLeaveActionType", "type": "Enum", - "label": "AppNavLinkStatus", + "label": "AppLeaveActionType", "tags": [ "public" ], "description": [ - "\nStatus of the application's navLink.\n" + "\nPossible type of actions on application leave.\n" ], "source": { "path": "src/core/public/application/types.ts", - "lineNumber": 40, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L40" + "lineNumber": 540, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L540" }, "initialIsOpen": false } diff --git a/api_docs/core_http.json b/api_docs/core_http.json index 13edda7ee6554..8e3a753da3a0b 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -2360,6 +2360,82 @@ }, "initialIsOpen": false }, + { + "id": "def-server.RouteValidationError", + "type": "Class", + "tags": [ + "public" + ], + "label": "RouteValidationError", + "description": [ + "\nError to return when the validation is not successful." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationError", + "text": "RouteValidationError" + }, + " extends ", + "SchemaTypeError" + ], + "children": [ + { + "id": "def-server.RouteValidationError.Unnamed", + "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], + "children": [ + { + "type": "CompoundType", + "label": "error", + "isRequired": true, + "signature": [ + "string | Error" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" + } + }, + { + "type": "Array", + "label": "path", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 16, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" + } + } + ], + "source": { + "path": "src/core/server/http/router/validator/validator_error.ts", + "lineNumber": 15, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L15" + }, + "initialIsOpen": false + }, { "id": "def-server.KibanaRequest", "type": "Class", @@ -2393,8 +2469,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 145, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L145" + "lineNumber": 144, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L144" } }, { @@ -2409,8 +2485,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 153, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L153" + "lineNumber": 152, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L152" } }, { @@ -2423,8 +2499,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 155, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L155" + "lineNumber": 154, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L154" }, "signature": [ "URL" @@ -2440,8 +2516,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 157, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L157" + "lineNumber": 156, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L156" }, "signature": [ "Readonly<{ path: string; method: ", @@ -2471,8 +2547,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 163, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L163" + "lineNumber": 162, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L162" }, "signature": [ { @@ -2494,8 +2570,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 168, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L168" + "lineNumber": 167, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L167" } }, { @@ -2508,8 +2584,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 171, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L171" + "lineNumber": 170, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L170" }, "signature": [ { @@ -2531,8 +2607,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 173, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L173" + "lineNumber": 172, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L172" }, "signature": [ { @@ -2552,8 +2628,8 @@ "description": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 174, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L174" + "lineNumber": 173, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L173" }, "signature": [ "{ isAuthenticated: boolean; }" @@ -2569,8 +2645,8 @@ ], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 182, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L182" + "lineNumber": 181, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L181" }, "signature": [ "URL", @@ -2596,8 +2672,8 @@ "description": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 188, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L188" + "lineNumber": 187, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L187" } }, { @@ -2610,8 +2686,8 @@ "description": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 189, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L189" + "lineNumber": 188, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L188" } }, { @@ -2624,8 +2700,8 @@ "description": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 190, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L190" + "lineNumber": 189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L189" } }, { @@ -2638,8 +2714,8 @@ "description": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 191, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L191" + "lineNumber": 190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L190" } }, { @@ -2652,8 +2728,8 @@ "description": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 194, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L194" + "lineNumber": 193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L193" } } ], @@ -2661,8 +2737,8 @@ "returnComment": [], "source": { "path": "src/core/server/http/router/request.ts", - "lineNumber": 187, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L187" + "lineNumber": 186, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L186" } } ], @@ -2672,82 +2748,6 @@ "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L90" }, "initialIsOpen": false - }, - { - "id": "def-server.RouteValidationError", - "type": "Class", - "tags": [ - "public" - ], - "label": "RouteValidationError", - "description": [ - "\nError to return when the validation is not successful." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RouteValidationError", - "text": "RouteValidationError" - }, - " extends ", - "SchemaTypeError" - ], - "children": [ - { - "id": "def-server.RouteValidationError.Unnamed", - "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], - "children": [ - { - "type": "CompoundType", - "label": "error", - "isRequired": true, - "signature": [ - "string | Error" - ], - "description": [], - "source": { - "path": "src/core/server/http/router/validator/validator_error.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" - } - }, - { - "type": "Array", - "label": "path", - "isRequired": true, - "signature": [ - "string[]" - ], - "description": [], - "source": { - "path": "src/core/server/http/router/validator/validator_error.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" - } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/http/router/validator/validator_error.ts", - "lineNumber": 16, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16" - } - } - ], - "source": { - "path": "src/core/server/http/router/validator/validator_error.ts", - "lineNumber": 15, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L15" - }, - "initialIsOpen": false } ], "functions": [], diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index a108fda2c12e0..01332a30010f1 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -3,191 +3,395 @@ "client": { "classes": [ { - "id": "def-public.SavedObjectsClient", + "id": "def-public.SimpleSavedObject", "type": "Class", "tags": [ "public" ], - "label": "SavedObjectsClient", + "label": "SimpleSavedObject", "description": [ - "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state. The client-side\nSavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" + "\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClient}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "" ], "children": [ { - "id": "def-public.SavedObjectsClient.create", - "type": "Function", - "children": [ - { - "type": "string", - "label": "type", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 221, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L221" - } - }, - { - "type": "Uncategorized", - "label": "attributes", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 222, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L222" - } - }, - { - "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 223, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L223" - } - } - ], + "tags": [], + "id": "def-public.SimpleSavedObject.attributes", + "type": "Uncategorized", + "label": "attributes", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L24" + }, + "signature": [ + "T" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject._version", + "type": "string", + "label": "_version", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 26, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L26" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.id", + "type": "string", + "label": "id", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 27, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L27" + } + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.type", + "type": "string", + "label": "type", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 28, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L28" + } + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.migrationVersion", + "type": "Object", + "label": "migrationVersion", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L29" + }, "signature": [ - "(type: string, attributes: T, options?: ", { "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" }, - ") => Promise<", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.coreMigrationVersion", + "type": "string", + "label": "coreMigrationVersion", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 30, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L30" + }, + "signature": [ + "string | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.error", + "type": "Object", + "label": "error", + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L31" + }, + "signature": [ { "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" }, - ">" - ], - "description": [ - "\nPersists an object\n" - ], - "label": "create", + " | undefined" + ] + }, + { + "tags": [], + "id": "def-public.SimpleSavedObject.references", + "type": "Array", + "label": "references", + "description": [], "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 220, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L220" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 32, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L32" }, - "tags": [], - "returnComment": [] + "signature": [ + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ] }, { - "id": "def-public.SavedObjectsClient.bulkCreate", + "id": "def-public.SimpleSavedObject.Unnamed", "type": "Function", + "label": "Constructor", + "signature": [ + "any" + ], + "description": [], "children": [ { - "type": "Array", - "label": "objects", + "type": "Object", + "label": "client", "isRequired": true, "signature": [ + "Pick<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "section": "def-public.SavedObjectsClient", + "text": "SavedObjectsClient" }, - "[]" + ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" ], "description": [], "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L256" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 35, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L35" } }, { "type": "Object", - "label": "options", + "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }", "isRequired": true, "signature": [ { "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - } + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "" ], "description": [], "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 257, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L257" + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 36, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L36" } } ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 34, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L34" + } + }, + { + "id": "def-public.SimpleSavedObject.get", + "type": "Function", + "label": "get", "signature": [ - "(objects?: ", + "(key: string) => any" + ], + "description": [], + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 59, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59" + } + }, + { + "id": "def-public.SimpleSavedObject.set", + "type": "Function", + "label": "set", + "signature": [ + "(key: string, value: any) => T" + ], + "description": [], + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + } }, - ") => Promise<", + { + "type": "Any", + "label": "value", + "isRequired": true, + "signature": [ + "any" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 63, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + } + }, + { + "id": "def-public.SimpleSavedObject.has", + "type": "Function", + "label": "has", + "signature": [ + "(key: string) => boolean" + ], + "description": [], + "children": [ + { + "type": "string", + "label": "key", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67" + } + }, + { + "id": "def-public.SimpleSavedObject.save", + "type": "Function", + "label": "save", + "signature": [ + "() => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, - ">" - ], - "description": [ - "\nCreates multiple documents at once\n" + ">" ], - "label": "bulkCreate", + "description": [], + "children": [], + "tags": [], + "returnComment": [], "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 255, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L255" - }, - "tags": [ - "property" - ], - "returnComment": [ - "The result of the create operation containing created saved objects." - ] + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 71, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L71" + } }, { - "id": "def-public.SavedObjectsClient.delete", + "id": "def-public.SimpleSavedObject.delete", + "type": "Function", + "label": "delete", + "signature": [ + "() => Promise<{}>" + ], + "description": [], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 86, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L86" + } + } + ], + "source": { + "path": "src/core/public/saved_objects/simple_saved_object.ts", + "lineNumber": 23, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L23" + }, + "initialIsOpen": false + }, + { + "id": "def-public.SavedObjectsClient", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsClient", + "description": [ + "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state. The client-side\nSavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" + ], + "children": [ + { + "id": "def-public.SavedObjectsClient.create", "type": "Function", "children": [ { @@ -200,139 +404,167 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 284, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L284" + "lineNumber": 221, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L221" } }, { - "type": "string", - "label": "id", + "type": "Uncategorized", + "label": "attributes", "isRequired": true, "signature": [ - "string" + "T" ], "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 285, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L285" + "lineNumber": 222, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L222" } }, { "type": "Object", "label": "options", - "isRequired": false, + "isRequired": true, "signature": [ { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - " | undefined" + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } ], "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 286, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L286" + "lineNumber": 223, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L223" } } ], "signature": [ - "(type: string, id: string, options?: ", + "(type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" + "section": "def-public.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, - " | undefined) => Promise<{}>" + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" ], "description": [ - "\nDeletes an object\n" + "\nPersists an object\n" ], - "label": "delete", + "label": "create", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 283, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L283" + "lineNumber": 220, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L220" }, "tags": [], "returnComment": [] }, { - "id": "def-public.SavedObjectsClient.find", + "id": "def-public.SavedObjectsClient.bulkCreate", "type": "Function", "children": [ { - "type": "Object", - "label": "options", - "isRequired": true, + "type": "Array", + "label": "objects", + "isRequired": true, "signature": [ - "Pick<", { "pluginId": "core", - "scope": "server", + "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">" + "[]" ], "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 314, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L314" + "lineNumber": 256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L256" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + } + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 257, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L257" } } ], "signature": [ - "(options: Pick<", + "(objects?: ", { "pluginId": "core", - "scope": "server", + "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-public.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" }, - ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", + "[], options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" + "section": "def-public.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" }, - ">" + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" ], "description": [ - "\nSearch for objects\n" + "\nCreates multiple documents at once\n" ], - "label": "find", + "label": "bulkCreate", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 313, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L313" + "lineNumber": 255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L255" }, "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", "property" ], "returnComment": [ - "A find result with objects matching the specified search." + "The result of the create operation containing created saved objects." ] }, { - "id": "def-public.SavedObjectsClient.get", + "id": "def-public.SavedObjectsClient.delete", "type": "Function", "children": [ { @@ -345,8 +577,8 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" + "lineNumber": 284, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L284" } }, { @@ -359,108 +591,126 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" + "lineNumber": 285, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L285" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": false, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined" + ], + "description": [], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 286, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L286" } } ], "signature": [ - "(type: string, id: string) => Promise<", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" + "section": "def-public.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, - ">" + " | undefined) => Promise<{}>" ], "description": [ - "\nFetches a single object\n" + "\nDeletes an object\n" ], - "label": "get", + "label": "delete", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 372, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" + "lineNumber": 283, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L283" }, "tags": [], - "returnComment": [ - "The saved object for the given type and id." - ] + "returnComment": [] }, { - "id": "def-public.SavedObjectsClient.bulkGet", + "id": "def-public.SavedObjectsClient.find", "type": "Function", "children": [ { - "type": "Array", - "label": "objects", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "{ id: string; type: string; }[]" + "Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">" ], "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 395, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395" + "lineNumber": 314, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L314" } } ], "signature": [ - "(objects?: { id: string; type: string; }[]) => Promise<", + "(options: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" + "section": "def-public.SavedObjectsFindResponsePublic", + "text": "SavedObjectsFindResponsePublic" }, - ">" + ">" ], "description": [ - "\nReturns an array of objects by id\n" + "\nSearch for objects\n" ], - "label": "bulkGet", + "label": "find", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 395, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395" + "lineNumber": 313, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L313" }, "tags": [ - "example" + "property", + "property", + "property", + "property", + "property", + "property", + "property" ], "returnComment": [ - "The saved objects with the given type and ids requested" + "A find result with objects matching the specified search." ] }, { - "id": "def-public.SavedObjectsClient.update", + "id": "def-public.SavedObjectsClient.get", "type": "Function", - "label": "update", - "signature": [ - "(type: string, id: string, attributes: T, { version, migrationVersion, references }?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" - ], - "description": [ - "\nUpdates an object\n" - ], "children": [ { "type": "string", @@ -472,8 +722,8 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 427, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L427" + "lineNumber": 372, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" } }, { @@ -486,499 +736,249 @@ "description": [], "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 428, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L428" - } - }, - { - "type": "Uncategorized", - "label": "attributes", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 429, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L429" - } - }, - { - "type": "Object", - "label": "{ version, migrationVersion, references }", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - } - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 430, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L430" + "lineNumber": 372, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" } } ], - "tags": [ - "prop", - "prop" - ], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 426, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L426" - } - }, - { - "id": "def-public.SavedObjectsClient.bulkUpdate", - "type": "Function", - "label": "bulkUpdate", "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]) => Promise<", + "(type: string, id: string) => Promise<", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" }, - ">" + ">" ], "description": [ - "\nUpdate multiple documents at once\n" - ], - "children": [ - { - "type": "Array", - "label": "objects", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]" - ], - "description": [ - "- [{ type, id, attributes, options: { version, references } }]" - ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 458, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458" - } - } - ], - "tags": [], - "returnComment": [ - "The result of the update operation containing both failed and updated saved objects." + "\nFetches a single object\n" ], + "label": "get", "source": { "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 458, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458" - } - } - ], - "source": { - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "lineNumber": 165, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L165" - }, - "initialIsOpen": false - }, - { - "id": "def-public.SimpleSavedObject", - "type": "Class", - "tags": [ - "public" - ], - "label": "SimpleSavedObject", - "description": [ - "\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClient}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - "" - ], - "children": [ - { - "tags": [], - "id": "def-public.SimpleSavedObject.attributes", - "type": "Uncategorized", - "label": "attributes", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L24" - }, - "signature": [ - "T" - ] - }, - { - "tags": [], - "id": "def-public.SimpleSavedObject._version", - "type": "string", - "label": "_version", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 26, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L26" - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.SimpleSavedObject.id", - "type": "string", - "label": "id", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 27, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L27" - } - }, - { - "tags": [], - "id": "def-public.SimpleSavedObject.type", - "type": "string", - "label": "type", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 28, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L28" - } - }, - { - "tags": [], - "id": "def-public.SimpleSavedObject.migrationVersion", - "type": "Object", - "label": "migrationVersion", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L29" - }, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectsMigrationVersion", - "text": "SavedObjectsMigrationVersion" - }, - " | undefined" - ] - }, - { - "tags": [], - "id": "def-public.SimpleSavedObject.coreMigrationVersion", - "type": "string", - "label": "coreMigrationVersion", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 30, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L30" - }, - "signature": [ - "string | undefined" - ] - }, - { - "tags": [], - "id": "def-public.SimpleSavedObject.error", - "type": "Object", - "label": "error", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L31" + "lineNumber": 372, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372" }, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectError", - "text": "SavedObjectError" - }, - " | undefined" - ] - }, - { "tags": [], - "id": "def-public.SimpleSavedObject.references", - "type": "Array", - "label": "references", - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 32, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L32" - }, - "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObjectReference", - "text": "SavedObjectReference" - }, - "[]" + "returnComment": [ + "The saved object for the given type and id." ] }, { - "id": "def-public.SimpleSavedObject.Unnamed", + "id": "def-public.SavedObjectsClient.bulkGet", "type": "Function", - "label": "Constructor", - "signature": [ - "any" - ], - "description": [], "children": [ { - "type": "Object", - "label": "client", - "isRequired": true, - "signature": [ - "Pick<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">" - ], - "description": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 35, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L35" - } - }, - { - "type": "Object", - "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }", + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" - }, - "" + "{ id: string; type: string; }[]" ], "description": [], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 36, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L36" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395" } } ], - "tags": [], - "returnComment": [], + "signature": [ + "(objects?: { id: string; type: string; }[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "description": [ + "\nReturns an array of objects by id\n" + ], + "label": "bulkGet", "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 34, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L34" - } + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 395, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395" + }, + "tags": [ + "example" + ], + "returnComment": [ + "The saved objects with the given type and ids requested" + ] }, { - "id": "def-public.SimpleSavedObject.get", + "id": "def-public.SavedObjectsClient.update", "type": "Function", - "label": "get", + "label": "update", "signature": [ - "(key: string) => any" + "(type: string, id: string, attributes: T, { version, migrationVersion, references }?: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "description": [ + "\nUpdates an object\n" ], - "description": [], "children": [ { "type": "string", - "label": "key", + "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 427, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L427" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 59, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59" - } - }, - { - "id": "def-public.SimpleSavedObject.set", - "type": "Function", - "label": "set", - "signature": [ - "(key: string, value: any) => T" - ], - "description": [], - "children": [ + }, { "type": "string", - "label": "key", + "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 63, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 428, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L428" } }, { - "type": "Any", - "label": "value", + "type": "Uncategorized", + "label": "attributes", "isRequired": true, "signature": [ - "any" + "T" ], "description": [], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 63, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 429, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L429" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 63, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63" - } - }, - { - "id": "def-public.SimpleSavedObject.has", - "type": "Function", - "label": "has", - "signature": [ - "(key: string) => boolean" - ], - "description": [], - "children": [ + }, { - "type": "string", - "label": "key", + "type": "Object", + "label": "{ version, migrationVersion, references }", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + } ], "description": [], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 67, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 430, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L430" } } ], - "tags": [], + "tags": [ + "prop", + "prop" + ], "returnComment": [], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 67, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 426, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L426" } }, { - "id": "def-public.SimpleSavedObject.save", + "id": "def-public.SavedObjectsClient.bulkUpdate", "type": "Function", - "label": "save", + "label": "bulkUpdate", "signature": [ - "() => Promise<", + "(objects?: ", { "pluginId": "core", "scope": "public", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" }, - ">" + "[]) => Promise<", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" ], - "description": [], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 71, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L71" - } - }, - { - "id": "def-public.SimpleSavedObject.delete", - "type": "Function", - "label": "delete", - "signature": [ - "() => Promise<{}>" + "description": [ + "\nUpdate multiple documents at once\n" + ], + "children": [ + { + "type": "Array", + "label": "objects", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-public.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "description": [ + "- [{ type, id, attributes, options: { version, references } }]" + ], + "source": { + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 458, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458" + } + } ], - "description": [], - "children": [], "tags": [], - "returnComment": [], + "returnComment": [ + "The result of the update operation containing both failed and updated saved objects." + ], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 86, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L86" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 458, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458" } } ], "source": { - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "lineNumber": 23, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L23" + "path": "src/core/public/saved_objects/saved_objects_client.ts", + "lineNumber": 165, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L165" }, "initialIsOpen": false } @@ -4754,300 +4754,366 @@ "initialIsOpen": false }, { - "id": "def-server.SavedObjectsRepository", + "id": "def-server.SavedObjectTypeRegistry", "type": "Class", "tags": [ "public" ], - "label": "SavedObjectsRepository", - "description": [], + "label": "SavedObjectTypeRegistry", + "description": [ + "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" + ], "children": [ { - "id": "def-server.SavedObjectsRepository.create", + "id": "def-server.SavedObjectTypeRegistry.registerType", "type": "Function", - "label": "create", + "label": "registerType", "signature": [ - "(type: string, attributes: T, options?: ", + "(type: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">" + ") => void" ], "description": [ - "\nPersists an object\n" + "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." ], "children": [ { - "type": "string", + "type": "Object", "label": "type", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + } ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 237, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L237" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31" } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 31, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getType", + "type": "Function", + "label": "getType", + "signature": [ + "(type: string) => ", { - "type": "Uncategorized", - "label": "attributes", - "isRequired": true, - "signature": [ - "T" - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 238, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L238" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, + " | undefined" + ], + "description": [ + "\nReturn the {@link SavedObjectsType | type} definition for given type name." + ], + "children": [ { - "type": "Object", - "label": "options", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } + "string" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 239, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L239" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42" } } ], - "tags": [ - "property", - "property", - "property", - "property", - "property" - ], - "returnComment": [ - "- { id, type, version, attributes }" - ], + "tags": [], + "returnComment": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 236, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L236" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 42, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42" } }, { - "id": "def-server.SavedObjectsRepository.bulkCreate", + "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", "type": "Function", - "label": "bulkCreate", + "label": "getVisibleTypes", "signature": [ - "(objects: ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - "[], options?: ", + "[]" + ], + "description": [ + "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 51, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L51" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getAllTypes", + "type": "Function", + "label": "getAllTypes", + "signature": [ + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => Promise<", + "[]" + ], + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 60, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L60" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", + "type": "Function", + "label": "getImportableAndExportableTypes", + "signature": [ + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">" + "[]" + ], + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L67" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", + "type": "Function", + "label": "isNamespaceAgnostic", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 75, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", + "type": "Function", + "label": "isSingleNamespace", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" + ], + "children": [ + { + "type": "string", + "label": "type", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83" + } + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 83, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", + "type": "Function", + "label": "isMultiNamespace", + "signature": [ + "(type: string) => boolean" ], "description": [ - "\nCreates multiple documents at once\n" + "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" ], "children": [ { - "type": "Array", - "label": "objects", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[]" - ], - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 330, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L330" - } - }, - { - "type": "Object", - "label": "options", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } + "string" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 331, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L331" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92" } } ], - "tags": [ - "property", - "property" - ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ], + "tags": [], + "returnComment": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 329, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L329" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 92, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92" } }, { - "id": "def-server.SavedObjectsRepository.checkConflicts", + "id": "def-server.SavedObjectTypeRegistry.isShareable", "type": "Function", - "label": "checkConflicts", + "label": "isShareable", "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">" + "(type: string) => boolean" ], "description": [ - "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." + "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" ], "children": [ { - "type": "Array", - "label": "objects", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[]" + "string" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 517, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L517" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101" } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 101, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isHidden", + "type": "Function", + "label": "isHidden", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + ], + "children": [ { - "type": "Object", - "label": "options", + "type": "string", + "label": "type", "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "string" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 518, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L518" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109" } } ], "tags": [], "returnComment": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 516, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L516" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 109, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109" } }, { - "id": "def-server.SavedObjectsRepository.delete", + "id": "def-server.SavedObjectTypeRegistry.getIndex", "type": "Function", - "label": "delete", + "label": "getIndex", "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>" + "(type: string) => string | undefined" ], "description": [ - "\nDeletes an object\n" + "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." ], "children": [ { @@ -5059,74 +5125,108 @@ ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 602, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117" } - }, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117" + } + }, + { + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "type": "Function", + "label": "isImportableAndExportable", + "signature": [ + "(type: string) => boolean" + ], + "description": [ + "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + ], + "children": [ { "type": "string", - "label": "id", + "label": "type", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 602, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125" } - }, - { - "type": "Object", - "label": "options", - "isRequired": true, + } + ], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 125, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125" + } + } + ], + "source": { + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "lineNumber": 24, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L24" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsUtils", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsUtils", + "description": [], + "children": [ + { + "id": "def-server.SavedObjectsUtils.namespaceIdToString", + "type": "Function", + "children": [ + { + "type": "string", + "label": "namespace", + "isRequired": false, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - } + "string | undefined" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 602, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29" } } ], - "tags": [ - "property" + "signature": [ + "(namespace?: string | undefined) => string" ], - "returnComment": [], + "description": [ + "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" + ], + "label": "namespaceIdToString", "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 602, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" - } + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 29, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29" + }, + "tags": [], + "returnComment": [] }, { - "id": "def-server.SavedObjectsRepository.deleteByNamespace", + "id": "def-server.SavedObjectsUtils.namespaceStringToId", "type": "Function", - "label": "deleteByNamespace", - "signature": [ - "(namespace: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - }, - ") => Promise" - ], - "description": [ - "\nDeletes all objects from the provided namespace.\n" - ], "children": [ { "type": "string", @@ -5137,48 +5237,54 @@ ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 664, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L664" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43" } - }, + } + ], + "signature": [ + "(namespace: string) => string | undefined" + ], + "description": [ + "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" + ], + "label": "namespaceStringToId", + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 43, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43" + }, + "tags": [], + "returnComment": [] + }, + { + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", + "type": "Function", + "children": [ { "type": "Object", - "label": "options", + "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" } ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 665, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L665" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54" } } ], - "tags": [], - "returnComment": [ - "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 663, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L663" - } - }, - { - "id": "def-server.SavedObjectsRepository.find", - "type": "Function", - "label": "find", "signature": [ - "(options: ", + "({ page, perPage, }: ", { "pluginId": "core", "scope": "server", @@ -5186,7 +5292,7 @@ "section": "def-server.SavedObjectsFindOptions", "text": "SavedObjectsFindOptions" }, - ") => Promise<", + ") => ", { "pluginId": "core", "scope": "server", @@ -5194,160 +5300,122 @@ "section": "def-server.SavedObjectsFindResponse", "text": "SavedObjectsFindResponse" }, - ">" - ], - "description": [], - "children": [ - { - "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 725, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725" - } - } - ], - "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property" + "" ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + "description": [ + "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." ], + "label": "createEmptyFindResponse", "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 725, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725" - } + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 54, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54" + }, + "tags": [], + "returnComment": [] }, { - "id": "def-server.SavedObjectsRepository.bulkGet", + "id": "def-server.SavedObjectsUtils.generateId", "type": "Function", - "label": "bulkGet", + "label": "generateId", "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" }, - ") => Promise<", + ".generateId" + ], + "description": [ + "\nGenerates a random ID for a saved objects." + ], + "children": [], + "tags": [], + "returnComment": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 67, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L67" + } + }, + { + "id": "def-server.SavedObjectsUtils.isRandomId", + "type": "Function", + "label": "isRandomId", + "signature": [ + "typeof ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsUtils", + "text": "SavedObjectsUtils" }, - ">" + ".isRandomId" ], "description": [ - "\nReturns an array of objects by id\n" + "\nValidates that a saved object ID has been randomly generated.\n" ], "children": [ { - "type": "Array", - "label": "objects", - "isRequired": true, + "type": "string", + "label": "id", + "isRequired": false, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[]" + "string | undefined" ], "description": [ - "- an array of objects containing id, type and optionally fields" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 875, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L875" - } - }, - { - "type": "Object", - "label": "options", - "isRequired": true, - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "The ID of a saved object." ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 876, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L876" + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77" } } ], "tags": [ - "property", - "example" - ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }] }" + "todo" ], + "returnComment": [], "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 874, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L874" + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 77, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77" } - }, + } + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "lineNumber": 22, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L22" + }, + "initialIsOpen": false + }, + { + "id": "def-server.SavedObjectsRepository", + "type": "Class", + "tags": [ + "public" + ], + "label": "SavedObjectsRepository", + "description": [], + "children": [ { - "id": "def-server.SavedObjectsRepository.get", + "id": "def-server.SavedObjectsRepository.create", "type": "Function", - "label": "get", + "label": "create", "signature": [ - "(type: string, id: string, options?: ", + "(type: string, attributes: T, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, ") => Promise<", { @@ -5360,7 +5428,7 @@ ">" ], "description": [ - "\nGets a single object\n" + "\nPersists an object\n" ], "children": [ { @@ -5373,22 +5441,22 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 960, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L960" + "lineNumber": 237, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L237" } }, { - "type": "string", - "label": "id", + "type": "Uncategorized", + "label": "attributes", "isRequired": true, "signature": [ - "string" + "T" ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 961, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L961" + "lineNumber": 238, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L238" } }, { @@ -5400,19 +5468,23 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 962, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L962" + "lineNumber": 239, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L239" } } ], "tags": [ + "property", + "property", + "property", + "property", "property" ], "returnComment": [ @@ -5420,63 +5492,66 @@ ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 959, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L959" + "lineNumber": 236, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L236" } }, { - "id": "def-server.SavedObjectsRepository.resolve", + "id": "def-server.SavedObjectsRepository.bulkCreate", "type": "Function", - "label": "resolve", + "label": "bulkCreate", "signature": [ - "(type: string, id: string, options?: ", + "(objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" }, ">" ], "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" + "\nCreates multiple documents at once\n" ], "children": [ { - "type": "string", - "label": "type", + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 998, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L998" - } - }, - { - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" ], - "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 999, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L999" + "lineNumber": 330, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L330" } }, { @@ -5488,97 +5563,85 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1000, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1000" + "lineNumber": 331, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L331" } } ], "tags": [ + "property", "property" ], "returnComment": [ - "- { saved_object, outcome }" + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 997, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L997" + "lineNumber": 329, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L329" } }, { - "id": "def-server.SavedObjectsRepository.update", + "id": "def-server.SavedObjectsRepository.checkConflicts", "type": "Function", - "label": "update", + "label": "checkConflicts", "signature": [ - "(type: string, id: string, attributes: Partial, options?: ", + "(objects?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" }, - ">" + ">" ], "description": [ - "\nUpdates an object\n" + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." ], "children": [ { - "type": "string", - "label": "type", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1117" - } - }, - { - "type": "string", - "label": "id", - "isRequired": true, - "signature": [ - "string" - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1118, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1118" - } - }, - { - "type": "Object", - "label": "attributes", + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - "Partial" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[]" ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1119, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1119" + "lineNumber": 517, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L517" } }, { @@ -5590,55 +5653,43 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1120, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1120" + "lineNumber": 518, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L518" } } ], - "tags": [ - "property", - "property", - "property" - ], + "tags": [], "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1116, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1116" + "lineNumber": 516, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L516" } }, { - "id": "def-server.SavedObjectsRepository.addToNamespaces", + "id": "def-server.SavedObjectsRepository.delete", "type": "Function", - "label": "addToNamespaces", + "label": "delete", "signature": [ - "(type: string, id: string, namespaces: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsAddToNamespacesOptions", - "text": "SavedObjectsAddToNamespacesOptions" - }, - ") => Promise<", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsAddToNamespacesResponse", - "text": "SavedObjectsAddToNamespacesResponse" + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" }, - ">" + ") => Promise<{}>" ], "description": [ - "\nAdds one or more namespaces to a given multi-namespace saved object. This method and\n[`deleteFromNamespaces`]{@link SavedObjectsRepository.deleteFromNamespaces} are the only ways to change which Spaces a multi-namespace\nsaved object is shared to." + "\nDeletes an object\n" ], "children": [ { @@ -5651,8 +5702,8 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1190, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1190" + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" } }, { @@ -5665,22 +5716,8 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1191, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1191" - } - }, - { - "type": "Array", - "label": "namespaces", - "isRequired": true, - "signature": [ - "string[]" - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1192, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1192" + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" } }, { @@ -5692,56 +5729,50 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsAddToNamespacesOptions", - "text": "SavedObjectsAddToNamespacesOptions" + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1193, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1193" + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" } } ], - "tags": [], + "tags": [ + "property" + ], "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1189, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1189" + "lineNumber": 602, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602" } }, { - "id": "def-server.SavedObjectsRepository.deleteFromNamespaces", + "id": "def-server.SavedObjectsRepository.deleteByNamespace", "type": "Function", - "label": "deleteFromNamespaces", + "label": "deleteByNamespace", "signature": [ - "(type: string, id: string, namespaces: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", - "text": "SavedObjectsDeleteFromNamespacesOptions" - }, - ") => Promise<", + "(namespace: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteFromNamespacesResponse", - "text": "SavedObjectsDeleteFromNamespacesResponse" + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" }, - ">" + ") => Promise" ], "description": [ - "\nRemoves one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted\nentirely. This method and [`addToNamespaces`]{@link SavedObjectsRepository.addToNamespaces} are the only ways to change which Spaces a\nmulti-namespace saved object is shared to." + "\nDeletes all objects from the provided namespace.\n" ], "children": [ { "type": "string", - "label": "type", + "label": "namespace", "isRequired": true, "signature": [ "string" @@ -5749,38 +5780,66 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1253, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1253" + "lineNumber": 664, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L664" } }, { - "type": "string", - "label": "id", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1254, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1254" + "lineNumber": 665, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L665" } + } + ], + "tags": [], + "returnComment": [ + "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 663, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L663" + } + }, + { + "id": "def-server.SavedObjectsRepository.find", + "type": "Function", + "label": "find", + "signature": [ + "(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" }, + ") => Promise<", { - "type": "Array", - "label": "namespaces", - "isRequired": true, - "signature": [ - "string[]" - ], - "description": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1255, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1255" - } + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" }, + ">" + ], + "description": [], + "children": [ { "type": "Object", "label": "options", @@ -5790,59 +5849,76 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", - "text": "SavedObjectsDeleteFromNamespacesOptions" + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1256, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1256" + "lineNumber": 725, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725" } } ], - "tags": [], - "returnComment": [], + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1252, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1252" + "lineNumber": 725, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725" } }, { - "id": "def-server.SavedObjectsRepository.bulkUpdate", + "id": "def-server.SavedObjectsRepository.bulkGet", "type": "Function", - "label": "bulkUpdate", + "label": "bulkGet", "signature": [ - "(objects: ", + "(objects?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" }, - "[], options?: ", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" }, ">" ], "description": [ - "\nUpdates multiple objects in bulk\n" + "\nReturns an array of objects by id\n" ], "children": [ { @@ -5854,18 +5930,18 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" }, - "[]" + "[]" ], "description": [ - "- [{ type, id, attributes, options: { version, namespace } references }]" + "- an array of objects containing id, type and optionally fields" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1358, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1358" + "lineNumber": 875, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L875" } }, { @@ -5877,56 +5953,56 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1359, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1359" + "lineNumber": 876, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L876" } } ], "tags": [ "property", - "property" + "example" ], "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + "- { saved_objects: [{ id, type, version, attributes }] }" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1357, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1357" + "lineNumber": 874, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L874" } }, { - "id": "def-server.SavedObjectsRepository.removeReferencesTo", + "id": "def-server.SavedObjectsRepository.get", "type": "Function", - "label": "removeReferencesTo", + "label": "get", "signature": [ - "(type: string, id: string, options?: ", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, ") => Promise<", { "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" }, - ">" + ">" ], "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + "\nGets a single object\n" ], "children": [ { @@ -5939,8 +6015,8 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1573, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1573" + "lineNumber": 960, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L960" } }, { @@ -5953,8 +6029,8 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1574, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1574" + "lineNumber": 961, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L961" } }, { @@ -5966,61 +6042,55 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1575, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1575" + "lineNumber": 962, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L962" } } ], "tags": [ - "remarks" + "property" + ], + "returnComment": [ + "- { id, type, version, attributes }" ], - "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1572, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1572" + "lineNumber": 959, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L959" } }, { - "id": "def-server.SavedObjectsRepository.incrementCounter", + "id": "def-server.SavedObjectsRepository.resolve", "type": "Function", - "label": "incrementCounter", + "label": "resolve", "signature": [ - "(type: string, id: string, counterFields: (string | ", + "(type: string, id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, - ")[], options?: ", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "common", - "docId": "kibCorePluginApi", - "section": "def-common.SavedObject", - "text": "SavedObject" + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" }, ">" ], "description": [ - "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" + "\nResolves a single object, using any legacy URL alias if it exists\n" ], "children": [ { @@ -6030,13 +6100,11 @@ "signature": [ "string" ], - "description": [ - "- The type of saved object whose fields should be incremented" - ], + "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1670, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1670" + "lineNumber": 998, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L998" } }, { @@ -6046,37 +6114,11 @@ "signature": [ "string" ], - "description": [ - "- The id of the document whose fields should be incremented" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1671, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1671" - } - }, - { - "type": "Array", - "label": "counterFields", - "isRequired": true, - "signature": [ - "(string | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" - }, - ")[]" - ], - "description": [ - "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}" - ], + "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1672, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1672" + "lineNumber": 999, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L999" } }, { @@ -6088,139 +6130,162 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" } ], - "description": [ - "- {@link SavedObjectsIncrementCounterOptions}" - ], + "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1673, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1673" + "lineNumber": 1000, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1000" } } ], "tags": [ - "remarks", - "example" + "property" ], "returnComment": [ - "The saved object after the specified fields were incremented" + "- { saved_object, outcome }" ], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1669, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1669" + "lineNumber": 997, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L997" } }, { - "id": "def-server.SavedObjectsRepository.openPointInTimeForType", + "id": "def-server.SavedObjectsRepository.update", "type": "Function", - "label": "openPointInTimeForType", + "label": "update", "signature": [ - "(type: string | string[], { keepAlive, preference }?: ", + "(type: string, id: string, attributes: Partial, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" }, ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" }, - ">" + ">" ], "description": [ - "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n" + "\nUpdates an object\n" ], "children": [ { - "type": "CompoundType", + "type": "string", "label": "type", "isRequired": true, "signature": [ - "string | string[]" + "string" ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1821, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1821" + "lineNumber": 1117, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1117" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1118, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1118" } }, { "type": "Object", - "label": "{ keepAlive = '5m', preference }", + "label": "attributes", + "isRequired": true, + "signature": [ + "Partial" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1119, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1119" + } + }, + { + "type": "Object", + "label": "options", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" } ], "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1822, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1822" + "lineNumber": 1120, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1120" } } ], "tags": [ - "example", + "property", "property", "property" ], - "returnComment": [ - "- { id: string }" - ], + "returnComment": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1820, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1820" + "lineNumber": 1116, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1116" } }, { - "id": "def-server.SavedObjectsRepository.closePointInTime", + "id": "def-server.SavedObjectsRepository.addToNamespaces", "type": "Function", - "label": "closePointInTime", + "label": "addToNamespaces", "signature": [ - "(id: string, options?: ", + "(type: string, id: string, namespaces: string[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" }, - " | undefined) => Promise<", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" + "section": "def-server.SavedObjectsAddToNamespacesResponse", + "text": "SavedObjectsAddToNamespacesResponse" }, ">" ], "description": [ - "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n" + "\nAdds one or more namespaces to a given multi-namespace saved object. This method and\n[`deleteFromNamespaces`]{@link SavedObjectsRepository.deleteFromNamespaces} are the only ways to change which Spaces a multi-namespace\nsaved object is shared to." ], "children": [ { "type": "string", - "label": "id", + "label": "type", "isRequired": true, "signature": [ "string" @@ -6228,131 +6293,92 @@ "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1890, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1890" + "lineNumber": 1190, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1190" } }, { - "type": "Object", - "label": "options", - "isRequired": false, + "type": "string", + "label": "id", + "isRequired": true, "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined" - ], - "description": [ - "- {@link SavedObjectsClosePointInTimeOptions}" + "string" ], + "description": [], "source": { "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1891, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1891" + "lineNumber": 1191, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1191" } - } - ], - "tags": [ - "remarks", - "example" - ], - "returnComment": [ - "- {@link SavedObjectsClosePointInTimeResponse}" - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 1889, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1889" - } - } - ], - "source": { - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "lineNumber": 143, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L143" - }, - "initialIsOpen": false - }, - { - "id": "def-server.SavedObjectTypeRegistry", - "type": "Class", - "tags": [ - "public" - ], - "label": "SavedObjectTypeRegistry", - "description": [ - "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" - ], - "children": [ - { - "id": "def-server.SavedObjectTypeRegistry.registerType", - "type": "Function", - "label": "registerType", - "signature": [ - "(type: ", + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "type": "Array", + "label": "namespaces", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1192, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1192" + } }, - ") => void" - ], - "description": [ - "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." - ], - "children": [ { "type": "Object", - "label": "type", + "label": "options", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsAddToNamespacesOptions", + "text": "SavedObjectsAddToNamespacesOptions" } ], "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1193, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1193" } } ], "tags": [], "returnComment": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 31, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1189, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1189" } }, { - "id": "def-server.SavedObjectTypeRegistry.getType", + "id": "def-server.SavedObjectsRepository.deleteFromNamespaces", "type": "Function", - "label": "getType", + "label": "deleteFromNamespaces", "signature": [ - "(type: string) => ", + "(type: string, id: string, namespaces: string[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" }, - " | undefined" + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesResponse", + "text": "SavedObjectsDeleteFromNamespacesResponse" + }, + ">" ], "description": [ - "\nReturn the {@link SavedObjectsType | type} definition for given type name." + "\nRemoves one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted\nentirely. This method and [`addToNamespaces`]{@link SavedObjectsRepository.addToNamespaces} are the only ways to change which Spaces a\nmulti-namespace saved object is shared to." ], "children": [ { @@ -6364,178 +6390,185 @@ ], "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 42, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1253, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1253" + } + }, + { + "type": "string", + "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1254, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1254" + } + }, + { + "type": "Array", + "label": "namespaces", + "isRequired": true, + "signature": [ + "string[]" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1255, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1255" + } + }, + { + "type": "Object", + "label": "options", + "isRequired": true, + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteFromNamespacesOptions", + "text": "SavedObjectsDeleteFromNamespacesOptions" + } + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1256, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1256" } } ], "tags": [], "returnComment": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 42, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1252, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1252" } }, { - "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", + "id": "def-server.SavedObjectsRepository.bulkUpdate", "type": "Function", - "label": "getVisibleTypes", + "label": "bulkUpdate", "signature": [ - "() => ", + "(objects: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" }, - "[]" - ], - "description": [ - "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." - ], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 51, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L51" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.getAllTypes", - "type": "Function", - "label": "getAllTypes", - "signature": [ - "() => ", + "[], options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" }, - "[]" - ], - "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." - ], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 60, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L60" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", - "type": "Function", - "label": "getImportableAndExportableTypes", - "signature": [ - "() => ", + ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" }, - "[]" - ], - "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." - ], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 67, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L67" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", - "type": "Function", - "label": "isNamespaceAgnostic", - "signature": [ - "(type: string) => boolean" + ">" ], "description": [ - "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" + "\nUpdates multiple objects in bulk\n" ], "children": [ { - "type": "string", - "label": "type", + "type": "Array", + "label": "objects", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" ], - "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1358, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1358" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 75, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", - "type": "Function", - "label": "isSingleNamespace", - "signature": [ - "(type: string) => boolean" - ], - "description": [ - "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" - ], - "children": [ + }, { - "type": "string", - "label": "type", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + } ], "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 83, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1359, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1359" } } ], - "tags": [], - "returnComment": [], + "tags": [ + "property", + "property" + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 83, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1357, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1357" } }, { - "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", + "id": "def-server.SavedObjectsRepository.removeReferencesTo", "type": "Function", - "label": "isMultiNamespace", + "label": "removeReferencesTo", "signature": [ - "(type: string) => boolean" + "(type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">" ], "description": [ - "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" ], "children": [ { @@ -6547,97 +6580,89 @@ ], "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 92, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1573, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1573" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 92, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.isShareable", - "type": "Function", - "label": "isShareable", - "signature": [ - "(type: string) => boolean" - ], - "description": [ - "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" - ], - "children": [ + }, { "type": "string", - "label": "type", + "label": "id", "isRequired": true, "signature": [ "string" ], "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1574, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1574" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 101, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.isHidden", - "type": "Function", - "label": "isHidden", - "signature": [ - "(type: string) => boolean" - ], - "description": [ - "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." - ], - "children": [ + }, { - "type": "string", - "label": "type", + "type": "Object", + "label": "options", "isRequired": true, "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + } ], "description": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 109, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1575, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1575" } } ], - "tags": [], + "tags": [ + "remarks" + ], "returnComment": [], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 109, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1572, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1572" } }, { - "id": "def-server.SavedObjectTypeRegistry.getIndex", + "id": "def-server.SavedObjectsRepository.incrementCounter", "type": "Function", - "label": "getIndex", + "label": "incrementCounter", "signature": [ - "(type: string) => string | undefined" + "(type: string, id: string, counterFields: (string | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "common", + "docId": "kibCorePluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + ">" ], "description": [ - "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." + "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" ], "children": [ { @@ -6647,275 +6672,250 @@ "signature": [ "string" ], - "description": [], + "description": [ + "- The type of saved object whose fields should be incremented" + ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1670, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1670" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 117, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117" - } - }, - { - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", - "type": "Function", - "label": "isImportableAndExportable", - "signature": [ - "(type: string) => boolean" - ], - "description": [ - "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." - ], - "children": [ + }, { "type": "string", - "label": "type", + "label": "id", "isRequired": true, "signature": [ "string" ], - "description": [], + "description": [ + "- The id of the document whose fields should be incremented" + ], "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1671, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1671" } - } - ], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 125, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125" - } - } - ], - "source": { - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "lineNumber": 24, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L24" - }, - "initialIsOpen": false - }, - { - "id": "def-server.SavedObjectsUtils", - "type": "Class", - "tags": [ - "public" - ], - "label": "SavedObjectsUtils", - "description": [], - "children": [ - { - "id": "def-server.SavedObjectsUtils.namespaceIdToString", - "type": "Function", - "children": [ + }, + { + "type": "Array", + "label": "counterFields", + "isRequired": true, + "signature": [ + "(string | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[]" + ], + "description": [ + "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}" + ], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1672, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1672" + } + }, { - "type": "string", - "label": "namespace", - "isRequired": false, + "type": "Object", + "label": "options", + "isRequired": true, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + } + ], + "description": [ + "- {@link SavedObjectsIncrementCounterOptions}" ], - "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1673, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1673" } } ], - "signature": [ - "(namespace?: string | undefined) => string" + "tags": [ + "remarks", + "example" ], - "description": [ - "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" + "returnComment": [ + "The saved object after the specified fields were incremented" ], - "label": "namespaceIdToString", "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 29, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29" - }, - "tags": [], - "returnComment": [] + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1669, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1669" + } }, { - "id": "def-server.SavedObjectsUtils.namespaceStringToId", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType", "type": "Function", + "label": "openPointInTimeForType", + "signature": [ + "(type: string | string[], { keepAlive, preference }?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">" + ], + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n" + ], "children": [ { - "type": "string", - "label": "namespace", + "type": "CompoundType", + "label": "type", "isRequired": true, "signature": [ - "string" + "string | string[]" ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1821, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1821" } - } - ], - "signature": [ - "(namespace: string) => string | undefined" - ], - "description": [ - "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" - ], - "label": "namespaceStringToId", - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 43, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43" - }, - "tags": [], - "returnComment": [] - }, - { - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", - "type": "Function", - "children": [ + }, { "type": "Object", - "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", + "label": "{ keepAlive = '5m', preference }", "isRequired": true, "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" } ], "description": [], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1822, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1822" } } ], - "signature": [ - "({ page, perPage, }: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - "" + "tags": [ + "example", + "property", + "property" ], - "description": [ - "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." + "returnComment": [ + "- { id: string }" ], - "label": "createEmptyFindResponse", "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 54, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54" - }, - "tags": [], - "returnComment": [] + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1820, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1820" + } }, { - "id": "def-server.SavedObjectsUtils.generateId", + "id": "def-server.SavedObjectsRepository.closePointInTime", "type": "Function", - "label": "generateId", + "label": "closePointInTime", "signature": [ - "typeof ", + "(id: string, options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUtils", - "text": "SavedObjectsUtils" + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" }, - ".generateId" - ], - "description": [ - "\nGenerates a random ID for a saved objects." - ], - "children": [], - "tags": [], - "returnComment": [], - "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 67, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L67" - } - }, - { - "id": "def-server.SavedObjectsUtils.isRandomId", - "type": "Function", - "label": "isRandomId", - "signature": [ - "typeof ", + " | undefined) => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUtils", - "text": "SavedObjectsUtils" + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" }, - ".isRandomId" + ">" ], "description": [ - "\nValidates that a saved object ID has been randomly generated.\n" + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n" ], "children": [ { "type": "string", "label": "id", + "isRequired": true, + "signature": [ + "string" + ], + "description": [], + "source": { + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1890, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1890" + } + }, + { + "type": "Object", + "label": "options", "isRequired": false, "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" ], "description": [ - "The ID of a saved object." + "- {@link SavedObjectsClosePointInTimeOptions}" ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 77, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1891, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1891" } } ], "tags": [ - "todo" + "remarks", + "example" + ], + "returnComment": [ + "- {@link SavedObjectsClosePointInTimeResponse}" ], - "returnComment": [], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 77, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 1889, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1889" } } ], "source": { - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "lineNumber": 22, - "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L22" + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "lineNumber": 143, + "link": "https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L143" }, "initialIsOpen": false }, diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.description.md b/docs/development/core/server/kibana-plugin-core-server.explanation.description.md deleted file mode 100644 index 37fc90f5ac5d8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.description.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) > [description](./kibana-plugin-core-server.explanation.description.md) - -## Explanation.description property - -Signature: - -```typescript -description: string; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.details.md b/docs/development/core/server/kibana-plugin-core-server.explanation.details.md deleted file mode 100644 index afba9175d86cf..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.details.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) > [details](./kibana-plugin-core-server.explanation.details.md) - -## Explanation.details property - -Signature: - -```typescript -details: Explanation[]; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.md b/docs/development/core/server/kibana-plugin-core-server.explanation.md deleted file mode 100644 index eb18910c4795b..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) - -## Explanation interface - - -Signature: - -```typescript -export interface Explanation -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description](./kibana-plugin-core-server.explanation.description.md) | string | | -| [details](./kibana-plugin-core-server.explanation.details.md) | Explanation[] | | -| [value](./kibana-plugin-core-server.explanation.value.md) | number | | - diff --git a/docs/development/core/server/kibana-plugin-core-server.explanation.value.md b/docs/development/core/server/kibana-plugin-core-server.explanation.value.md deleted file mode 100644 index b10f60176b0c8..0000000000000 --- a/docs/development/core/server/kibana-plugin-core-server.explanation.value.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [Explanation](./kibana-plugin-core-server.explanation.md) > [value](./kibana-plugin-core-server.explanation.value.md) - -## Explanation.value property - -Signature: - -```typescript -value: number; -``` diff --git a/docs/development/core/server/kibana-plugin-core-server.md b/docs/development/core/server/kibana-plugin-core-server.md index d14e41cfb56ec..8dd4667002ead 100644 --- a/docs/development/core/server/kibana-plugin-core-server.md +++ b/docs/development/core/server/kibana-plugin-core-server.md @@ -75,7 +75,6 @@ The plugin integrates with the core system via lifecycle events: `setup` | [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) | | | [ElasticsearchStatusMeta](./kibana-plugin-core-server.elasticsearchstatusmeta.md) | | | [ErrorHttpResponseOptions](./kibana-plugin-core-server.errorhttpresponseoptions.md) | HTTP response parameters | -| [Explanation](./kibana-plugin-core-server.explanation.md) | | | [FakeRequest](./kibana-plugin-core-server.fakerequest.md) | Fake request object created manually by Kibana plugins. | | [GetResponse](./kibana-plugin-core-server.getresponse.md) | | | [HttpAuth](./kibana-plugin-core-server.httpauth.md) | | diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md index 92f5f4e2aff24..eb18e064c84e2 100644 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md +++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsrepository.incrementcounter.md @@ -31,7 +31,7 @@ The saved object after the specified fields were incremented When supplying a field name like `stats.api.counter` the field name will be used as-is to create a document like: `{attributes: {'stats.api.counter': 1}}` It will not create a nested structure like: `{attributes: {stats: {api: {counter: 1}}}}` -When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/master/src/plugins/usage\_collection/README.md\#tracking-interactions-with-incrementcounter) +When using incrementCounter for collecting usage data, you need to ensure that usage collection happens on a best-effort basis and doesn't negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/master/src/plugins/usage\_collection/README.mdx\#tracking-interactions-with-incrementcounter) ## Example diff --git a/packages/kbn-test/src/functional_test_runner/lib/index.ts b/packages/kbn-test/src/functional_test_runner/lib/index.ts index 69354c4582cdc..eef9e833fe5a8 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/index.ts +++ b/packages/kbn-test/src/functional_test_runner/lib/index.ts @@ -9,8 +9,10 @@ export { Lifecycle } from './lifecycle'; export { LifecyclePhase } from './lifecycle_phase'; export { readConfigFile, Config } from './config'; -export { readProviderSpec, ProviderCollection, Provider } from './providers'; +export { readProviderSpec, ProviderCollection } from './providers'; export { runTests, setupMocha } from './mocha'; export { FailureMetadata } from './failure_metadata'; export * from './docker_servers'; export { SuiteTracker } from './suite_tracker'; + +export type { Provider } from './providers'; diff --git a/packages/kbn-test/src/functional_test_runner/lib/providers/index.ts b/packages/kbn-test/src/functional_test_runner/lib/providers/index.ts index 70abfdc51d757..10aeca19ba45a 100644 --- a/packages/kbn-test/src/functional_test_runner/lib/providers/index.ts +++ b/packages/kbn-test/src/functional_test_runner/lib/providers/index.ts @@ -7,4 +7,5 @@ */ export { ProviderCollection } from './provider_collection'; -export { Provider, readProviderSpec } from './read_provider_spec'; +export { readProviderSpec } from './read_provider_spec'; +export type { Provider } from './read_provider_spec'; diff --git a/src/core/public/application/capabilities/index.ts b/src/core/public/application/capabilities/index.ts index fa7fafa307a3c..930f748878d2e 100644 --- a/src/core/public/application/capabilities/index.ts +++ b/src/core/public/application/capabilities/index.ts @@ -6,5 +6,5 @@ * Side Public License, v 1. */ -export { Capabilities } from '../../../types/capabilities'; +export type { Capabilities } from '../../../types/capabilities'; export { CapabilitiesService } from './capabilities_service'; diff --git a/src/core/public/application/index.ts b/src/core/public/application/index.ts index 14349e2ace3d9..1e9a91717e81a 100644 --- a/src/core/public/application/index.ts +++ b/src/core/public/application/index.ts @@ -7,15 +7,15 @@ */ export { ApplicationService } from './application_service'; -export { Capabilities } from './capabilities'; export { ScopedHistory } from './scoped_history'; -export { +export { AppNavLinkStatus, AppStatus } from './types'; + +export type { Capabilities } from './capabilities'; +export type { App, AppMount, AppUnmount, AppMountParameters, - AppStatus, - AppNavLinkStatus, AppUpdatableFields, AppUpdater, AppMeta, diff --git a/src/core/public/chrome/chrome_service.tsx b/src/core/public/chrome/chrome_service.tsx index e69bf9025fdb9..5ed447edde75a 100644 --- a/src/core/public/chrome/chrome_service.tsx +++ b/src/core/public/chrome/chrome_service.tsx @@ -24,7 +24,6 @@ import { ChromeNavControls, NavControlsService } from './nav_controls'; import { NavLinksService, ChromeNavLink } from './nav_links'; import { ChromeRecentlyAccessed, RecentlyAccessedService } from './recently_accessed'; import { Header } from './ui'; -export { ChromeNavControls, ChromeRecentlyAccessed, ChromeDocTitle }; import { ChromeBadge, ChromeBrand, @@ -35,6 +34,8 @@ import { ChromeUserBanner, } from './types'; +export type { ChromeNavControls, ChromeRecentlyAccessed, ChromeDocTitle }; + const IS_LOCKED_KEY = 'core.chrome.isLocked'; interface ConstructorParams { diff --git a/src/core/public/chrome/index.ts b/src/core/public/chrome/index.ts index 069d29ca70d01..73499a81f2220 100644 --- a/src/core/public/chrome/index.ts +++ b/src/core/public/chrome/index.ts @@ -7,7 +7,7 @@ */ export { ChromeService } from './chrome_service'; -export { +export type { ChromeHelpExtensionLinkBase, ChromeHelpExtensionMenuLink, ChromeHelpExtensionMenuCustomLink, @@ -15,12 +15,15 @@ export { ChromeHelpExtensionMenuDocumentationLink, ChromeHelpExtensionMenuGitHubLink, } from './ui/header/header_help_menu'; -export { NavType } from './ui'; -export { ChromeNavLink, ChromeNavLinks, ChromeNavLinkUpdateableFields } from './nav_links'; -export { ChromeRecentlyAccessed, ChromeRecentlyAccessedHistoryItem } from './recently_accessed'; -export { ChromeNavControl, ChromeNavControls } from './nav_controls'; -export { ChromeDocTitle } from './doc_title'; -export { +export type { NavType } from './ui'; +export type { ChromeNavLink, ChromeNavLinks, ChromeNavLinkUpdateableFields } from './nav_links'; +export type { + ChromeRecentlyAccessed, + ChromeRecentlyAccessedHistoryItem, +} from './recently_accessed'; +export type { ChromeNavControl, ChromeNavControls } from './nav_controls'; +export type { ChromeDocTitle } from './doc_title'; +export type { InternalChromeStart, ChromeStart, ChromeHelpExtension, diff --git a/src/core/public/chrome/nav_links/index.ts b/src/core/public/chrome/nav_links/index.ts index 7e0f8d851589b..a35a512b2a842 100644 --- a/src/core/public/chrome/nav_links/index.ts +++ b/src/core/public/chrome/nav_links/index.ts @@ -5,6 +5,7 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ +export { NavLinksService } from './nav_links_service'; -export { ChromeNavLink, ChromeNavLinkUpdateableFields } from './nav_link'; -export { ChromeNavLinks, NavLinksService } from './nav_links_service'; +export type { ChromeNavLink, ChromeNavLinkUpdateableFields } from './nav_link'; +export type { ChromeNavLinks } from './nav_links_service'; diff --git a/src/core/public/chrome/recently_accessed/index.ts b/src/core/public/chrome/recently_accessed/index.ts index 7f8bbef1f038c..d4494edbf9bcf 100644 --- a/src/core/public/chrome/recently_accessed/index.ts +++ b/src/core/public/chrome/recently_accessed/index.ts @@ -5,9 +5,8 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - -export { +export { RecentlyAccessedService } from './recently_accessed_service'; +export type { ChromeRecentlyAccessed, ChromeRecentlyAccessedHistoryItem, - RecentlyAccessedService, } from './recently_accessed_service'; diff --git a/src/core/public/chrome/ui/header/index.ts b/src/core/public/chrome/ui/header/index.ts index 761b26548d641..633555ced16d0 100644 --- a/src/core/public/chrome/ui/header/index.ts +++ b/src/core/public/chrome/ui/header/index.ts @@ -6,9 +6,10 @@ * Side Public License, v 1. */ -export { Header, HeaderProps } from './header'; -export { OnIsLockedUpdate, NavType } from './types'; -export { +export { Header } from './header'; +export type { HeaderProps } from './header'; +export type { OnIsLockedUpdate, NavType } from './types'; +export type { ChromeHelpExtensionLinkBase, ChromeHelpExtensionMenuLink, ChromeHelpExtensionMenuCustomLink, diff --git a/src/core/public/chrome/ui/index.ts b/src/core/public/chrome/ui/index.ts index 6d9d6238738c2..da66d3eeacc75 100644 --- a/src/core/public/chrome/ui/index.ts +++ b/src/core/public/chrome/ui/index.ts @@ -6,9 +6,9 @@ * Side Public License, v 1. */ +export { Header } from './header'; export { LoadingIndicator } from './loading_indicator'; -export { - Header, +export type { ChromeHelpExtensionLinkBase, ChromeHelpExtensionMenuLink, ChromeHelpExtensionMenuCustomLink, diff --git a/src/core/public/core_app/status/lib/index.ts b/src/core/public/core_app/status/lib/index.ts index 52bf17f92091e..c3434e07319b0 100644 --- a/src/core/public/core_app/status/lib/index.ts +++ b/src/core/public/core_app/status/lib/index.ts @@ -6,5 +6,7 @@ * Side Public License, v 1. */ -export { formatNumber, DataType } from './format_number'; -export { loadStatus, Metric, FormattedStatus, ProcessedServerResponse } from './load_status'; +export { formatNumber } from './format_number'; +export { loadStatus } from './load_status'; +export type { DataType } from './format_number'; +export type { Metric, FormattedStatus, ProcessedServerResponse } from './load_status'; diff --git a/src/core/public/doc_links/index.ts b/src/core/public/doc_links/index.ts index 0e7b5e6486dff..e615b5ab8d5d2 100644 --- a/src/core/public/doc_links/index.ts +++ b/src/core/public/doc_links/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { DocLinksService, DocLinksStart } from './doc_links_service'; +export { DocLinksService } from './doc_links_service'; +export type { DocLinksStart } from './doc_links_service'; diff --git a/src/core/public/fatal_errors/index.ts b/src/core/public/fatal_errors/index.ts index a148a42a684ac..bb6590c691296 100644 --- a/src/core/public/fatal_errors/index.ts +++ b/src/core/public/fatal_errors/index.ts @@ -6,5 +6,6 @@ * Side Public License, v 1. */ -export { FatalErrorsSetup, FatalErrorsStart, FatalErrorsService } from './fatal_errors_service'; -export { FatalErrorInfo } from './get_error_info'; +export { FatalErrorsService } from './fatal_errors_service'; +export type { FatalErrorsSetup, FatalErrorsStart } from './fatal_errors_service'; +export type { FatalErrorInfo } from './get_error_info'; diff --git a/src/core/public/i18n/index.ts b/src/core/public/i18n/index.ts index 0e6c99598460a..791920dd31372 100644 --- a/src/core/public/i18n/index.ts +++ b/src/core/public/i18n/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { I18nService, I18nStart } from './i18n_service'; +export { I18nService } from './i18n_service'; +export type { I18nStart } from './i18n_service'; diff --git a/src/core/public/index.ts b/src/core/public/index.ts index 67a7f15fd9241..c7b4c370eb6d7 100644 --- a/src/core/public/index.ts +++ b/src/core/public/index.ts @@ -66,10 +66,10 @@ import { ApplicationSetup, Capabilities, ApplicationStart } from './application' import { DocLinksStart } from './doc_links'; import { SavedObjectsStart } from './saved_objects'; -export { PackageInfo, EnvironmentMode, IExternalUrlPolicy } from '../server/types'; -export { CoreContext, CoreSystem } from './core_system'; +export type { PackageInfo, EnvironmentMode, IExternalUrlPolicy } from '../server/types'; +export type { CoreContext, CoreSystem } from './core_system'; export { DEFAULT_APP_CATEGORIES } from '../utils'; -export { +export type { AppCategory, UiSettingsParams, UserProvidedValues, @@ -80,7 +80,8 @@ export { StringValidationRegexString, } from '../types'; -export { +export { AppNavLinkStatus, AppStatus, ScopedHistory } from './application'; +export type { ApplicationSetup, ApplicationStart, App, @@ -92,8 +93,6 @@ export { AppLeaveAction, AppLeaveDefaultAction, AppLeaveConfirmAction, - AppStatus, - AppNavLinkStatus, AppMeta, AppUpdatableFields, AppUpdater, @@ -101,11 +100,11 @@ export { PublicAppInfo, PublicAppMetaInfo, PublicAppSearchDeepLinkInfo, - ScopedHistory, NavigateToAppOptions, } from './application'; -export { +export { SimpleSavedObject } from './saved_objects'; +export type { SavedObjectsBatchResponse, SavedObjectsBulkCreateObject, SavedObjectsBulkCreateOptions, @@ -126,7 +125,6 @@ export { SavedObjectsMigrationVersion, SavedObjectsClientContract, SavedObjectsClient, - SimpleSavedObject, SavedObjectsImportResponse, SavedObjectsImportSuccess, SavedObjectsImportConflictError, @@ -142,10 +140,11 @@ export { SavedObjectsImportWarning, } from './saved_objects'; -export { +export { HttpFetchError } from './http'; + +export type { HttpHeadersInit, HttpRequestInit, - HttpFetchError, HttpFetchOptions, HttpFetchOptionsWithPath, HttpFetchQuery, @@ -162,7 +161,7 @@ export { IHttpResponseInterceptorOverrides, } from './http'; -export { +export type { OverlayStart, OverlayBannersStart, OverlayRef, @@ -173,7 +172,7 @@ export { OverlayModalStart, } from './overlays'; -export { +export type { Toast, ToastInput, IToasts, @@ -185,7 +184,7 @@ export { ErrorToastOptions, } from './notifications'; -export { MountPoint, UnmountCallback, PublicUiSettingsParams } from './types'; +export type { MountPoint, UnmountCallback, PublicUiSettingsParams } from './types'; export { URL_MAX_LENGTH } from './core_app'; @@ -280,7 +279,7 @@ export interface CoreStart { }; } -export { +export type { Capabilities, ChromeBadge, ChromeBrand, diff --git a/src/core/public/injected_metadata/index.ts b/src/core/public/injected_metadata/index.ts index 8eca95aaa01fb..b2c4413ed5ff3 100644 --- a/src/core/public/injected_metadata/index.ts +++ b/src/core/public/injected_metadata/index.ts @@ -5,9 +5,8 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - -export { - InjectedMetadataService, +export { InjectedMetadataService } from './injected_metadata_service'; +export type { InjectedMetadataParams, InjectedMetadataSetup, InjectedMetadataStart, diff --git a/src/core/public/notifications/index.ts b/src/core/public/notifications/index.ts index f751db62a452a..e93ff5c751399 100644 --- a/src/core/public/notifications/index.ts +++ b/src/core/public/notifications/index.ts @@ -5,8 +5,8 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - -export { +export { NotificationsService } from './notifications_service'; +export type { ErrorToastOptions, ToastOptions, Toast, @@ -17,8 +17,4 @@ export { ToastsSetup, ToastsStart, } from './toasts'; -export { - NotificationsService, - NotificationsSetup, - NotificationsStart, -} from './notifications_service'; +export type { NotificationsSetup, NotificationsStart } from './notifications_service'; diff --git a/src/core/public/notifications/toasts/index.ts b/src/core/public/notifications/toasts/index.ts index 59975ba0ce735..6681ca4a8e8f3 100644 --- a/src/core/public/notifications/toasts/index.ts +++ b/src/core/public/notifications/toasts/index.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ -export { ToastsService, ToastsSetup, ToastsStart } from './toasts_service'; -export { +export { ToastsService } from './toasts_service'; +export type { ToastsSetup, ToastsStart } from './toasts_service'; +export type { ErrorToastOptions, ToastOptions, ToastsApi, diff --git a/src/core/public/overlays/banners/index.ts b/src/core/public/overlays/banners/index.ts index 071ff06086a28..18d465d1240c3 100644 --- a/src/core/public/overlays/banners/index.ts +++ b/src/core/public/overlays/banners/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { OverlayBannersStart, OverlayBannersService } from './banners_service'; +export { OverlayBannersService } from './banners_service'; +export type { OverlayBannersStart } from './banners_service'; diff --git a/src/core/public/overlays/flyout/index.ts b/src/core/public/overlays/flyout/index.ts index d433ca10739f1..0945f5a6e5c6d 100644 --- a/src/core/public/overlays/flyout/index.ts +++ b/src/core/public/overlays/flyout/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { FlyoutService, OverlayFlyoutStart, OverlayFlyoutOpenOptions } from './flyout_service'; +export { FlyoutService } from './flyout_service'; +export type { OverlayFlyoutStart, OverlayFlyoutOpenOptions } from './flyout_service'; diff --git a/src/core/public/overlays/index.ts b/src/core/public/overlays/index.ts index f9158c772f8f3..93d1c1c479152 100644 --- a/src/core/public/overlays/index.ts +++ b/src/core/public/overlays/index.ts @@ -5,9 +5,14 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ +export { OverlayService } from './overlay_service'; -export { OverlayRef } from './types'; -export { OverlayBannersStart } from './banners'; -export { OverlayFlyoutStart, OverlayFlyoutOpenOptions } from './flyout'; -export { OverlayModalStart, OverlayModalOpenOptions, OverlayModalConfirmOptions } from './modal'; -export { OverlayService, OverlayStart } from './overlay_service'; +export type { OverlayRef } from './types'; +export type { OverlayBannersStart } from './banners'; +export type { OverlayFlyoutStart, OverlayFlyoutOpenOptions } from './flyout'; +export type { + OverlayModalStart, + OverlayModalOpenOptions, + OverlayModalConfirmOptions, +} from './modal'; +export type { OverlayStart } from './overlay_service'; diff --git a/src/core/public/overlays/modal/index.ts b/src/core/public/overlays/modal/index.ts index 1c467d9d35287..ac8aba588e720 100644 --- a/src/core/public/overlays/modal/index.ts +++ b/src/core/public/overlays/modal/index.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ -export { - ModalService, +export { ModalService } from './modal_service'; + +export type { OverlayModalStart, OverlayModalOpenOptions, OverlayModalConfirmOptions, diff --git a/src/core/public/plugins/index.ts b/src/core/public/plugins/index.ts index be805c6a521ce..9d7a61ef47a0d 100644 --- a/src/core/public/plugins/index.ts +++ b/src/core/public/plugins/index.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export * from './plugins_service'; -export { Plugin, AsyncPlugin, PluginInitializer } from './plugin'; -export { PluginInitializerContext } from './plugin_context'; -export { PluginOpaqueId } from '../../server/types'; +export { PluginsService } from './plugins_service'; +export type { Plugin, AsyncPlugin, PluginInitializer } from './plugin'; +export type { PluginInitializerContext } from './plugin_context'; +export type { PluginOpaqueId } from '../../server/types'; diff --git a/src/core/public/saved_objects/index.ts b/src/core/public/saved_objects/index.ts index d2704b9a01c56..e8aef50376841 100644 --- a/src/core/public/saved_objects/index.ts +++ b/src/core/public/saved_objects/index.ts @@ -5,8 +5,9 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ +export { SavedObjectsService } from './saved_objects_service'; -export { +export type { SavedObjectsBatchResponse, SavedObjectsBulkCreateObject, SavedObjectsBulkCreateOptions, @@ -19,8 +20,8 @@ export { SavedObjectsBulkUpdateOptions, } from './saved_objects_client'; export { SimpleSavedObject } from './simple_saved_object'; -export { SavedObjectsStart, SavedObjectsService } from './saved_objects_service'; -export { +export type { SavedObjectsStart } from './saved_objects_service'; +export type { SavedObjectsBaseOptions, SavedObjectsFindOptions, SavedObjectsFindOptionsReference, @@ -40,7 +41,7 @@ export { SavedObjectsImportWarning, } from '../../server/types'; -export { +export type { SavedObject, SavedObjectAttribute, SavedObjectAttributes, diff --git a/src/core/public/types.ts b/src/core/public/types.ts index c33c64298d6df..2561aefb615d4 100644 --- a/src/core/public/types.ts +++ b/src/core/public/types.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export { +export type { UiSettingsParams, PublicUiSettingsParams, UserProvidedValues, diff --git a/src/core/public/ui_settings/index.ts b/src/core/public/ui_settings/index.ts index 901d3eed36f0e..7c7bdae34a3c1 100644 --- a/src/core/public/ui_settings/index.ts +++ b/src/core/public/ui_settings/index.ts @@ -7,5 +7,5 @@ */ export { UiSettingsService } from './ui_settings_service'; -export { UiSettingsClient } from './ui_settings_client'; -export { UiSettingsState, IUiSettingsClient } from './types'; +export type { UiSettingsClient } from './ui_settings_client'; +export type { UiSettingsState, IUiSettingsClient } from './types'; diff --git a/src/core/server/capabilities/index.ts b/src/core/server/capabilities/index.ts index ed93112dc0cf7..161357b5c1972 100644 --- a/src/core/server/capabilities/index.ts +++ b/src/core/server/capabilities/index.ts @@ -6,10 +6,10 @@ * Side Public License, v 1. */ -export { - CapabilitiesService, +export { CapabilitiesService } from './capabilities_service'; +export type { CapabilitiesSetup, CapabilitiesStart, ResolveCapabilitiesOptions, } from './capabilities_service'; -export { Capabilities, CapabilitiesSwitcher, CapabilitiesProvider } from './types'; +export type { Capabilities, CapabilitiesSwitcher, CapabilitiesProvider } from './types'; diff --git a/src/core/server/capabilities/types.ts b/src/core/server/capabilities/types.ts index 1dabd0ac080c0..bfff74172cfce 100644 --- a/src/core/server/capabilities/types.ts +++ b/src/core/server/capabilities/types.ts @@ -9,7 +9,7 @@ import { Capabilities } from '../../types/capabilities'; import { KibanaRequest } from '../http'; -export { Capabilities }; +export type { Capabilities }; /** * See {@link CapabilitiesSetup} diff --git a/src/core/server/config/index.ts b/src/core/server/config/index.ts index f40c532b7b06a..bf2ce16e869b7 100644 --- a/src/core/server/config/index.ts +++ b/src/core/server/config/index.ts @@ -10,16 +10,19 @@ export { coreDeprecationProvider } from './deprecation'; export { ConfigService, - IConfigService, + isConfigPath, + hasConfigPathIntersection, + Env, + ObjectToConfigAdapter, RawConfigService, +} from '@kbn/config'; + +export type { + IConfigService, RawConfigurationProvider, Config, ConfigPath, - isConfigPath, - hasConfigPathIntersection, - ObjectToConfigAdapter, CliArgs, - Env, ConfigDeprecation, ConfigDeprecationLogger, ConfigDeprecationProvider, diff --git a/src/core/server/context/index.ts b/src/core/server/context/index.ts index 1d8b2e5463038..84f7ad07da2c3 100644 --- a/src/core/server/context/index.ts +++ b/src/core/server/context/index.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ -export { ContextService, ContextSetup } from './context_service'; -export { +export { ContextService } from './context_service'; +export type { ContextSetup } from './context_service'; +export type { IContextContainer, IContextProvider, HandlerFunction, diff --git a/src/core/server/core_usage_data/index.ts b/src/core/server/core_usage_data/index.ts index 4b050b31da325..4e0200ed1e4ea 100644 --- a/src/core/server/core_usage_data/index.ts +++ b/src/core/server/core_usage_data/index.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export { CoreUsageDataSetup, CoreUsageDataStart } from './types'; +export type { CoreUsageDataSetup, CoreUsageDataStart } from './types'; export { CoreUsageDataService } from './core_usage_data_service'; export { CoreUsageStatsClient } from './core_usage_stats_client'; @@ -20,7 +20,7 @@ import { CoreServicesUsageData, } from './types'; -export { +export type { CoreUsageStats, CoreUsageData, CoreConfigUsageData, diff --git a/src/core/server/csp/index.ts b/src/core/server/csp/index.ts index ed30081ed82b2..94577cf727829 100644 --- a/src/core/server/csp/index.ts +++ b/src/core/server/csp/index.ts @@ -9,4 +9,5 @@ import { CspConfig, ICspConfig } from './csp_config'; import { CspConfigType, config } from './config'; -export { CspConfig, CspConfigType, config, ICspConfig }; +export { CspConfig, config }; +export type { CspConfigType, ICspConfig }; diff --git a/src/core/server/dev/index.ts b/src/core/server/dev/index.ts index cde5dc4363a21..6e0fd343d2ec8 100644 --- a/src/core/server/dev/index.ts +++ b/src/core/server/dev/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { config, DevConfig, DevConfigType } from './dev_config'; +export { config, DevConfig } from './dev_config'; +export type { DevConfigType } from './dev_config'; diff --git a/src/core/server/elasticsearch/client/index.ts b/src/core/server/elasticsearch/client/index.ts index 990aac4b2a95e..c7600b723ade0 100644 --- a/src/core/server/elasticsearch/client/index.ts +++ b/src/core/server/elasticsearch/client/index.ts @@ -6,9 +6,19 @@ * Side Public License, v 1. */ -export * from './types'; -export { IScopedClusterClient, ScopedClusterClient } from './scoped_cluster_client'; -export { ElasticsearchClientConfig } from './client_config'; -export { IClusterClient, ICustomClusterClient, ClusterClient } from './cluster_client'; +export type { + ElasticsearchClient, + ShardsResponse, + ShardsInfo, + CountResponse, + SearchResponse, + GetResponse, + DeleteDocumentResponse, +} from './types'; +export { ScopedClusterClient } from './scoped_cluster_client'; +export type { IScopedClusterClient } from './scoped_cluster_client'; +export type { ElasticsearchClientConfig } from './client_config'; +export { ClusterClient } from './cluster_client'; +export type { IClusterClient, ICustomClusterClient } from './cluster_client'; export { configureClient } from './configure_client'; export { retryCallCluster, migrationRetryCallCluster } from './retry_call_cluster'; diff --git a/src/core/server/elasticsearch/index.ts b/src/core/server/elasticsearch/index.ts index 35d857bf1b1dd..94dc10ff4e863 100644 --- a/src/core/server/elasticsearch/index.ts +++ b/src/core/server/elasticsearch/index.ts @@ -7,9 +7,10 @@ */ export { ElasticsearchService } from './elasticsearch_service'; -export { config, configSchema, ElasticsearchConfig } from './elasticsearch_config'; -export { NodesVersionCompatibility } from './version_check/ensure_es_version'; -export { +export { config, configSchema } from './elasticsearch_config'; +export { ElasticsearchConfig } from './elasticsearch_config'; +export type { NodesVersionCompatibility } from './version_check/ensure_es_version'; +export type { ElasticsearchServiceSetup, ElasticsearchServiceStart, ElasticsearchStatusMeta, @@ -19,7 +20,7 @@ export { ScopeableRequest, } from './types'; export * from './legacy'; -export { +export type { IClusterClient, ICustomClusterClient, ElasticsearchClientConfig, @@ -30,7 +31,6 @@ export { CountResponse, ShardsInfo, ShardsResponse, - Explanation, GetResponse, DeleteDocumentResponse, } from './client'; diff --git a/src/core/server/elasticsearch/legacy/index.ts b/src/core/server/elasticsearch/legacy/index.ts index 377557de14c17..d98b7f16635a1 100644 --- a/src/core/server/elasticsearch/legacy/index.ts +++ b/src/core/server/elasticsearch/legacy/index.ts @@ -6,12 +6,13 @@ * Side Public License, v 1. */ -export { - LegacyClusterClient, - ILegacyClusterClient, - ILegacyCustomClusterClient, -} from './cluster_client'; -export { ILegacyScopedClusterClient, LegacyScopedClusterClient } from './scoped_cluster_client'; -export { LegacyElasticsearchClientConfig } from './elasticsearch_client_config'; -export { LegacyElasticsearchError, LegacyElasticsearchErrorHelpers } from './errors'; +export { LegacyClusterClient } from './cluster_client'; +export type { ILegacyClusterClient, ILegacyCustomClusterClient } from './cluster_client'; +export type { + ILegacyScopedClusterClient, + LegacyScopedClusterClient, +} from './scoped_cluster_client'; +export type { LegacyElasticsearchClientConfig } from './elasticsearch_client_config'; +export { LegacyElasticsearchErrorHelpers } from './errors'; +export type { LegacyElasticsearchError } from './errors'; export * from './api_types'; diff --git a/src/core/server/environment/index.ts b/src/core/server/environment/index.ts index bb0f012732688..01d5097887248 100644 --- a/src/core/server/environment/index.ts +++ b/src/core/server/environment/index.ts @@ -6,5 +6,7 @@ * Side Public License, v 1. */ -export { EnvironmentService, InternalEnvironmentServiceSetup } from './environment_service'; -export { config, PidConfigType } from './pid_config'; +export { EnvironmentService } from './environment_service'; +export type { InternalEnvironmentServiceSetup } from './environment_service'; +export { config } from './pid_config'; +export type { PidConfigType } from './pid_config'; diff --git a/src/core/server/external_url/index.ts b/src/core/server/external_url/index.ts index ee77fa383cbfc..846f8912b8ac9 100644 --- a/src/core/server/external_url/index.ts +++ b/src/core/server/external_url/index.ts @@ -6,5 +6,7 @@ * Side Public License, v 1. */ -export { ExternalUrlConfig, IExternalUrlConfig, IExternalUrlPolicy } from './external_url_config'; -export { ExternalUrlConfigType, config } from './config'; +export { ExternalUrlConfig } from './external_url_config'; +export type { IExternalUrlConfig, IExternalUrlPolicy } from './external_url_config'; +export { config } from './config'; +export type { ExternalUrlConfigType } from './config'; diff --git a/src/core/server/http/index.ts b/src/core/server/http/index.ts index ace6d9b1d1942..c35b7e2fcd042 100644 --- a/src/core/server/http/index.ts +++ b/src/core/server/http/index.ts @@ -6,20 +6,25 @@ * Side Public License, v 1. */ -export { config, HttpConfig, HttpConfigType } from './http_config'; +export { config, HttpConfig } from './http_config'; +export type { HttpConfigType } from './http_config'; export { HttpService } from './http_service'; -export { GetAuthHeaders } from './auth_headers_storage'; -export { AuthStatus, GetAuthState, IsAuthenticated } from './auth_state_storage'; +export type { GetAuthHeaders } from './auth_headers_storage'; +export type { AuthStatus, GetAuthState, IsAuthenticated } from './auth_state_storage'; export { - CustomHttpResponseOptions, - IKibanaSocket, isKibanaRequest, isRealRequest, + KibanaRequest, + kibanaResponseFactory, + validBodyOutput, +} from './router'; +export type { + CustomHttpResponseOptions, + IKibanaSocket, Headers, HttpResponseOptions, HttpResponsePayload, ErrorHttpResponseOptions, - KibanaRequest, KibanaRequestEvents, KibanaRequestRoute, KibanaRequestRouteOptions, @@ -33,7 +38,6 @@ export { ResponseError, ResponseErrorAttributes, ResponseHeaders, - kibanaResponseFactory, KibanaResponseFactory, RouteConfig, IRouter, @@ -42,7 +46,6 @@ export { RouteConfigOptions, RouteConfigOptionsBody, RouteContentType, - validBodyOutput, RouteValidatorConfig, RouteValidationSpec, RouteValidationFunction, @@ -54,8 +57,8 @@ export { SafeRouteMethod, } from './router'; export { BasePathProxyServer } from './base_path_proxy_server'; -export { OnPreRoutingHandler, OnPreRoutingToolkit } from './lifecycle/on_pre_routing'; -export { +export type { OnPreRoutingHandler, OnPreRoutingToolkit } from './lifecycle/on_pre_routing'; +export type { AuthenticationHandler, AuthHeaders, AuthResultParams, @@ -67,19 +70,29 @@ export { AuthNotHandled, AuthResultType, } from './lifecycle/auth'; -export { OnPostAuthHandler, OnPostAuthToolkit } from './lifecycle/on_post_auth'; -export { OnPreAuthHandler, OnPreAuthToolkit } from './lifecycle/on_pre_auth'; -export { +export type { OnPostAuthHandler, OnPostAuthToolkit } from './lifecycle/on_post_auth'; +export type { OnPreAuthHandler, OnPreAuthToolkit } from './lifecycle/on_pre_auth'; +export type { OnPreResponseHandler, OnPreResponseToolkit, OnPreResponseRender, OnPreResponseExtensions, OnPreResponseInfo, } from './lifecycle/on_pre_response'; -export { SessionStorageFactory, SessionStorage } from './session_storage'; -export { +export type { SessionStorageFactory, SessionStorage } from './session_storage'; +export type { SessionStorageCookieOptions, SessionCookieValidationResult, } from './cookie_session_storage'; -export * from './types'; -export { BasePath, IBasePath } from './base_path_service'; +export type { + RequestHandlerContextContainer, + RequestHandlerContextProvider, + HttpAuth, + HttpServiceSetup, + InternalHttpServiceSetup, + HttpServiceStart, + InternalHttpServiceStart, + HttpServerInfo, +} from './types'; +export { BasePath } from './base_path_service'; +export type { IBasePath } from './base_path_service'; diff --git a/src/core/server/http/router/index.ts b/src/core/server/http/router/index.ts index c1733107a49be..a958d330bf24d 100644 --- a/src/core/server/http/router/index.ts +++ b/src/core/server/http/router/index.ts @@ -6,33 +6,37 @@ * Side Public License, v 1. */ -export { Headers, filterHeaders, ResponseHeaders, KnownHeaders } from './headers'; -export { Router, RequestHandler, RequestHandlerWrapper, IRouter, RouteRegistrar } from './router'; -export { - KibanaRequest, +export { filterHeaders } from './headers'; +export type { Headers, ResponseHeaders, KnownHeaders } from './headers'; +export { Router } from './router'; +export type { RequestHandler, RequestHandlerWrapper, IRouter, RouteRegistrar } from './router'; +export { isKibanaRequest, isRealRequest, ensureRawRequest, KibanaRequest } from './request'; +export type { KibanaRequestEvents, KibanaRequestRoute, KibanaRequestRouteOptions, KibanaRouteOptions, KibanaRequestState, - isKibanaRequest, - isRealRequest, LegacyRequest, - ensureRawRequest, } from './request'; -export { +export { isSafeMethod, validBodyOutput } from './route'; +export type { DestructiveRouteMethod, - isSafeMethod, RouteMethod, RouteConfig, RouteConfigOptions, RouteContentType, RouteConfigOptionsBody, SafeRouteMethod, - validBodyOutput, } from './route'; export { HapiResponseAdapter } from './response_adapter'; export { + kibanaResponseFactory, + lifecycleResponseFactory, + isKibanaResponse, + KibanaResponse, +} from './response'; +export type { CustomHttpResponseOptions, HttpResponseOptions, HttpResponsePayload, @@ -40,18 +44,14 @@ export { RedirectResponseOptions, ResponseError, ResponseErrorAttributes, - KibanaResponse, IKibanaResponse, - kibanaResponseFactory, KibanaResponseFactory, - lifecycleResponseFactory, LifecycleResponseFactory, - isKibanaResponse, } from './response'; -export { IKibanaSocket } from './socket'; +export type { IKibanaSocket } from './socket'; -export { +export type { RouteValidatorConfig, RouteValidationSpec, RouteValidationFunction, diff --git a/src/core/server/http/router/request.ts b/src/core/server/http/router/request.ts index 47daf72c9679e..42e342f762e4d 100644 --- a/src/core/server/http/router/request.ts +++ b/src/core/server/http/router/request.ts @@ -131,7 +131,6 @@ export class KibanaRequest< const params = routeValidator.getParams(req.params, 'request params'); const query = routeValidator.getQuery(req.query, 'request query'); const body = routeValidator.getBody(req.payload, 'request body'); - return { query, params, body }; } /** diff --git a/src/core/server/http/router/validator/index.ts b/src/core/server/http/router/validator/index.ts index 6e83b67b76d80..17a4bba02f16a 100644 --- a/src/core/server/http/router/validator/index.ts +++ b/src/core/server/http/router/validator/index.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -export { - RouteValidator, +export { RouteValidator } from './validator'; +export type { RouteValidatorConfig, RouteValidationSpec, RouteValidationFunction, diff --git a/src/core/server/http_resources/index.ts b/src/core/server/http_resources/index.ts index 6a0940a5fd886..19970553c0a3c 100644 --- a/src/core/server/http_resources/index.ts +++ b/src/core/server/http_resources/index.ts @@ -8,7 +8,7 @@ export { HttpResourcesService } from './http_resources_service'; -export { +export type { HttpResourcesRenderOptions, HttpResourcesResponseOptions, HttpResourcesServiceToolkit, diff --git a/src/core/server/i18n/index.ts b/src/core/server/i18n/index.ts index 3ad4797ece404..8bc01a598e0d0 100644 --- a/src/core/server/i18n/index.ts +++ b/src/core/server/i18n/index.ts @@ -6,5 +6,7 @@ * Side Public License, v 1. */ -export { config, I18nConfigType } from './i18n_config'; -export { I18nService, I18nServiceSetup } from './i18n_service'; +export { config } from './i18n_config'; +export type { I18nConfigType } from './i18n_config'; +export { I18nService } from './i18n_service'; +export type { I18nServiceSetup } from './i18n_service'; diff --git a/src/core/server/index.ts b/src/core/server/index.ts index 8e4cdc7d59e32..3e336dceb83d7 100644 --- a/src/core/server/index.ts +++ b/src/core/server/index.ts @@ -68,7 +68,7 @@ import { CoreServicesUsageData, } from './core_usage_data'; -export { +export type { CoreUsageStats, CoreUsageData, CoreConfigUsageData, @@ -77,13 +77,13 @@ export { }; export { bootstrap } from './bootstrap'; -export { +export type { Capabilities, CapabilitiesProvider, CapabilitiesSwitcher, ResolveCapabilitiesOptions, } from './capabilities'; -export { +export type { ConfigPath, ConfigService, ConfigDeprecation, @@ -93,22 +93,25 @@ export { EnvironmentMode, PackageInfo, } from './config'; -export { +export type { IContextContainer, IContextProvider, HandlerFunction, HandlerContextType, HandlerParameters, } from './context'; -export { CoreId } from './core_context'; -export { CspConfig, ICspConfig } from './csp'; -export { +export type { CoreId } from './core_context'; + +export { CspConfig } from './csp'; +export type { ICspConfig } from './csp'; + +export { ElasticsearchConfig } from './elasticsearch'; +export type { LegacyClusterClient, ILegacyClusterClient, ILegacyCustomClusterClient, LegacyScopedClusterClient, ILegacyScopedClusterClient, - ElasticsearchConfig, LegacyElasticsearchClientConfig, LegacyElasticsearchError, LegacyElasticsearchErrorHelpers, @@ -128,13 +131,23 @@ export { CountResponse, ShardsInfo, ShardsResponse, - Explanation, GetResponse, DeleteDocumentResponse, } from './elasticsearch'; -export * from './elasticsearch/legacy/api_types'; -export { IExternalUrlConfig, IExternalUrlPolicy } from './external_url'; -export { + +export type { + LegacyCallAPIOptions, + AssistantAPIClientParams, + MIGRATION_ASSISTANCE_INDEX_ACTION, + MIGRATION_DEPRECATION_LEVEL, + AssistanceAPIResponse, + DeprecationAPIClientParams, + DeprecationInfo, + IndexSettingsDeprecationInfo, + DeprecationAPIResponse, +} from './elasticsearch/legacy/api_types'; +export type { IExternalUrlConfig, IExternalUrlPolicy } from './external_url'; +export type { AuthenticationHandler, AuthHeaders, AuthResultParams, @@ -161,7 +174,6 @@ export { ErrorHttpResponseOptions, IKibanaSocket, IsAuthenticated, - KibanaRequest, KibanaRequestEvents, KibanaRequestRoute, KibanaRequestRouteOptions, @@ -188,7 +200,6 @@ export { ResponseError, ResponseErrorAttributes, ResponseHeaders, - kibanaResponseFactory, KibanaResponseFactory, RouteConfig, IRouter, @@ -197,7 +208,6 @@ export { RouteConfigOptions, RouteConfigOptionsBody, RouteContentType, - validBodyOutput, RouteValidatorConfig, RouteValidationSpec, RouteValidationFunction, @@ -213,15 +223,17 @@ export { SafeRouteMethod, } from './http'; -export { +export { KibanaRequest, kibanaResponseFactory, validBodyOutput } from './http'; + +export type { HttpResourcesRenderOptions, HttpResourcesResponseOptions, HttpResourcesServiceToolkit, HttpResourcesRequestHandler, } from './http_resources'; -export { IRenderOptions } from './rendering'; -export { +export type { IRenderOptions } from './rendering'; +export type { Logger, LoggerFactory, LogMeta, @@ -233,7 +245,7 @@ export { AppenderConfigType, } from './logging'; -export { +export type { DiscoveredPlugin, Plugin, AsyncPlugin, @@ -247,6 +259,14 @@ export { } from './plugins'; export { + SavedObjectsClient, + SavedObjectsErrorHelpers, + SavedObjectsSerializer, + SavedObjectTypeRegistry, + SavedObjectsUtils, +} from './saved_objects'; + +export type { SavedObjectsBulkCreateObject, SavedObjectsBulkGetObject, SavedObjectsBulkUpdateObject, @@ -255,7 +275,6 @@ export { SavedObjectsBulkUpdateResponse, SavedObjectsCheckConflictsObject, SavedObjectsCheckConflictsResponse, - SavedObjectsClient, SavedObjectsClientProviderOptions, SavedObjectsClientWrapperFactory, SavedObjectsClientWrapperOptions, @@ -264,7 +283,6 @@ export { SavedObjectsClosePointInTimeOptions, SavedObjectsClosePointInTimeResponse, SavedObjectsCreateOptions, - SavedObjectsErrorHelpers, SavedObjectsExportResultDetails, SavedObjectsFindResult, SavedObjectsFindResponse, @@ -289,7 +307,6 @@ export { SavedObjectsRepositoryFactory, SavedObjectsResolveImportErrorsOptions, SavedObjectsResolveResponse, - SavedObjectsSerializer, SavedObjectsUpdateOptions, SavedObjectsUpdateResponse, SavedObjectsAddToNamespacesOptions, @@ -312,14 +329,12 @@ export { SavedObjectsFieldMapping, SavedObjectsTypeMappingDefinition, SavedObjectsMappingProperties, - SavedObjectTypeRegistry, ISavedObjectTypeRegistry, SavedObjectsNamespaceType, SavedObjectsType, SavedObjectsTypeManagementDefinition, SavedObjectMigrationMap, SavedObjectMigrationFn, - SavedObjectsUtils, SavedObjectsExporter, ISavedObjectsExporter, SavedObjectExportBaseOptions, @@ -338,7 +353,7 @@ export { SavedObjectsImportWarning, } from './saved_objects'; -export { +export type { IUiSettingsClient, UiSettingsParams, PublicUiSettingsParams, @@ -353,7 +368,7 @@ export { StringValidationRegexString, } from './ui_settings'; -export { +export type { OpsMetrics, OpsOsMetrics, OpsServerMetrics, @@ -362,12 +377,12 @@ export { MetricsServiceStart, } from './metrics'; -export { I18nServiceSetup } from './i18n'; +export type { I18nServiceSetup } from './i18n'; -export { AppCategory } from '../types'; +export type { AppCategory } from '../types'; export { DEFAULT_APP_CATEGORIES } from '../utils'; -export { +export type { SavedObject, SavedObjectAttribute, SavedObjectAttributes, @@ -382,17 +397,12 @@ export { SavedObjectsMigrationVersion, } from './types'; -export { LegacyServiceSetupDeps, LegacyServiceStartDeps, LegacyConfig } from './legacy'; +export type { LegacyServiceSetupDeps, LegacyServiceStartDeps, LegacyConfig } from './legacy'; -export { - CoreStatus, - ServiceStatus, - ServiceStatusLevel, - ServiceStatusLevels, - StatusServiceSetup, -} from './status'; +export { ServiceStatusLevels } from './status'; +export type { CoreStatus, ServiceStatus, ServiceStatusLevel, StatusServiceSetup } from './status'; -export { CoreUsageDataStart } from './core_usage_data'; +export type { CoreUsageDataStart } from './core_usage_data'; /** * Plugin specific context passed to a route handler. @@ -507,7 +517,7 @@ export interface CoreStart { coreUsageData: CoreUsageDataStart; } -export { +export type { CapabilitiesSetup, CapabilitiesStart, ContextSetup, diff --git a/src/core/server/legacy/index.ts b/src/core/server/legacy/index.ts index 50e646486898f..8614265e4375d 100644 --- a/src/core/server/legacy/index.ts +++ b/src/core/server/legacy/index.ts @@ -9,6 +9,13 @@ /** @internal */ export { ensureValidConfiguration } from './config'; /** @internal */ -export { LegacyService, ILegacyService } from './legacy_service'; +export type { ILegacyService } from './legacy_service'; +export { LegacyService } from './legacy_service'; /** @internal */ -export * from './types'; +export type { + LegacyVars, + LegacyConfig, + LegacyServiceSetupDeps, + LegacyServiceStartDeps, + LegacyServiceSetupConfig, +} from './types'; diff --git a/src/core/server/logging/appenders/rewrite/policies/index.ts b/src/core/server/logging/appenders/rewrite/policies/index.ts index ae3be1e4de916..e4852ae9cde29 100644 --- a/src/core/server/logging/appenders/rewrite/policies/index.ts +++ b/src/core/server/logging/appenders/rewrite/policies/index.ts @@ -10,7 +10,7 @@ import { assertNever } from '@kbn/std'; import { RewritePolicy } from './policy'; import { MetaRewritePolicy, MetaRewritePolicyConfig, metaRewritePolicyConfigSchema } from './meta'; -export { RewritePolicy }; +export type { RewritePolicy }; /** * Available rewrite policies which specify what part of a {@link LogRecord} diff --git a/src/core/server/logging/appenders/rewrite/policies/meta/index.ts b/src/core/server/logging/appenders/rewrite/policies/meta/index.ts index afdfd6fb709d3..1fc2256687fef 100644 --- a/src/core/server/logging/appenders/rewrite/policies/meta/index.ts +++ b/src/core/server/logging/appenders/rewrite/policies/meta/index.ts @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -export { - MetaRewritePolicy, - MetaRewritePolicyConfig, - metaRewritePolicyConfigSchema, -} from './meta_policy'; +export { MetaRewritePolicy, metaRewritePolicyConfigSchema } from './meta_policy'; + +export type { MetaRewritePolicyConfig } from './meta_policy'; diff --git a/src/core/server/logging/appenders/rolling_file/policies/index.ts b/src/core/server/logging/appenders/rolling_file/policies/index.ts index e3e33c6cbfdef..735aac4a68747 100644 --- a/src/core/server/logging/appenders/rolling_file/policies/index.ts +++ b/src/core/server/logging/appenders/rolling_file/policies/index.ts @@ -22,7 +22,7 @@ import { timeIntervalTriggeringPolicyConfigSchema, } from './time_interval'; -export { TriggeringPolicy } from './policy'; +export type { TriggeringPolicy } from './policy'; /** * Any of the existing policy's configuration diff --git a/src/core/server/logging/appenders/rolling_file/policies/size_limit/index.ts b/src/core/server/logging/appenders/rolling_file/policies/size_limit/index.ts index c032407733d38..c6c5d97a74465 100644 --- a/src/core/server/logging/appenders/rolling_file/policies/size_limit/index.ts +++ b/src/core/server/logging/appenders/rolling_file/policies/size_limit/index.ts @@ -8,6 +8,7 @@ export { SizeLimitTriggeringPolicy, - SizeLimitTriggeringPolicyConfig, sizeLimitTriggeringPolicyConfigSchema, } from './size_limit_policy'; + +export type { SizeLimitTriggeringPolicyConfig } from './size_limit_policy'; diff --git a/src/core/server/logging/appenders/rolling_file/policies/time_interval/index.ts b/src/core/server/logging/appenders/rolling_file/policies/time_interval/index.ts index 116a569ac7bfb..152d1bd01c933 100644 --- a/src/core/server/logging/appenders/rolling_file/policies/time_interval/index.ts +++ b/src/core/server/logging/appenders/rolling_file/policies/time_interval/index.ts @@ -8,6 +8,7 @@ export { TimeIntervalTriggeringPolicy, - TimeIntervalTriggeringPolicyConfig, timeIntervalTriggeringPolicyConfigSchema, } from './time_interval_policy'; + +export type { TimeIntervalTriggeringPolicyConfig } from './time_interval_policy'; diff --git a/src/core/server/logging/appenders/rolling_file/strategies/index.ts b/src/core/server/logging/appenders/rolling_file/strategies/index.ts index c8364b0e590c6..d0b960be8883d 100644 --- a/src/core/server/logging/appenders/rolling_file/strategies/index.ts +++ b/src/core/server/logging/appenders/rolling_file/strategies/index.ts @@ -15,7 +15,7 @@ import { } from './numeric'; import { RollingFileContext } from '../rolling_file_context'; -export { RollingStrategy } from './strategy'; +export type { RollingStrategy } from './strategy'; export type RollingStrategyConfig = NumericRollingStrategyConfig; const defaultStrategy: NumericRollingStrategyConfig = { diff --git a/src/core/server/logging/appenders/rolling_file/strategies/numeric/index.ts b/src/core/server/logging/appenders/rolling_file/strategies/numeric/index.ts index 99f8fdebef4fc..d9e2f1b200457 100644 --- a/src/core/server/logging/appenders/rolling_file/strategies/numeric/index.ts +++ b/src/core/server/logging/appenders/rolling_file/strategies/numeric/index.ts @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -export { - NumericRollingStrategy, - NumericRollingStrategyConfig, - numericRollingStrategyConfigSchema, -} from './numeric_strategy'; +export { NumericRollingStrategy, numericRollingStrategyConfigSchema } from './numeric_strategy'; + +export type { NumericRollingStrategyConfig } from './numeric_strategy'; diff --git a/src/core/server/logging/index.ts b/src/core/server/logging/index.ts index 9b3d7747fc560..cef96be54870e 100644 --- a/src/core/server/logging/index.ts +++ b/src/core/server/logging/index.ts @@ -5,8 +5,8 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - -export { +export { LogLevel } from '@kbn/logging'; +export type { DisposableAppender, Appender, LogRecord, @@ -15,21 +15,20 @@ export { LogMeta, Logger, LogLevelId, - LogLevel, } from '@kbn/logging'; -export { EcsEvent, EcsEventKind, EcsEventCategory, EcsEventType } from './ecs'; -export { - config, +export { EcsEventType, EcsEventCategory, EcsEventKind } from './ecs'; +export type { EcsEvent } from './ecs'; +export { config } from './logging_config'; +export type { LoggingConfigType, LoggerContextConfigInput, LoggerConfigType, loggerContextConfigSchema, loggerSchema, } from './logging_config'; -export { LoggingSystem, ILoggingSystem } from './logging_system'; -export { - InternalLoggingServiceSetup, - LoggingServiceSetup, - LoggingService, -} from './logging_service'; -export { appendersSchema, AppenderConfigType } from './appenders/appenders'; +export { LoggingSystem } from './logging_system'; +export type { ILoggingSystem } from './logging_system'; +export { LoggingService } from './logging_service'; +export type { InternalLoggingServiceSetup, LoggingServiceSetup } from './logging_service'; +export { appendersSchema } from './appenders/appenders'; +export type { AppenderConfigType } from './appenders/appenders'; diff --git a/src/core/server/logging/layouts/conversions/index.ts b/src/core/server/logging/layouts/conversions/index.ts index 412a0af7a284a..9203fdd02278c 100644 --- a/src/core/server/logging/layouts/conversions/index.ts +++ b/src/core/server/logging/layouts/conversions/index.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export { Conversion } from './type'; +export type { Conversion } from './type'; export { LoggerConversion } from './logger'; export { LevelConversion } from './level'; diff --git a/src/core/server/logging/logger.mock.ts b/src/core/server/logging/logger.mock.ts index d33b87552f884..efab15b7bf5f4 100644 --- a/src/core/server/logging/logger.mock.ts +++ b/src/core/server/logging/logger.mock.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { loggerMock, MockedLogger } from '@kbn/logging/target/mocks'; +export { loggerMock } from '@kbn/logging/target/mocks'; +export type { MockedLogger } from '@kbn/logging/target/mocks'; diff --git a/src/core/server/metrics/collectors/index.ts b/src/core/server/metrics/collectors/index.ts index 0e09d0823d9d1..c04a55f9ffaaf 100644 --- a/src/core/server/metrics/collectors/index.ts +++ b/src/core/server/metrics/collectors/index.ts @@ -6,7 +6,8 @@ * Side Public License, v 1. */ -export { OpsProcessMetrics, OpsOsMetrics, OpsServerMetrics, MetricsCollector } from './types'; -export { OsMetricsCollector, OpsMetricsCollectorOptions } from './os'; +export type { OpsProcessMetrics, OpsOsMetrics, OpsServerMetrics, MetricsCollector } from './types'; +export { OsMetricsCollector } from './os'; +export type { OpsMetricsCollectorOptions } from './os'; export { ProcessMetricsCollector } from './process'; export { ServerMetricsCollector } from './server'; diff --git a/src/core/server/metrics/index.ts b/src/core/server/metrics/index.ts index a5c54e316d76d..3e358edf3a01e 100644 --- a/src/core/server/metrics/index.ts +++ b/src/core/server/metrics/index.ts @@ -6,13 +6,13 @@ * Side Public License, v 1. */ -export { +export type { InternalMetricsServiceStart, InternalMetricsServiceSetup, MetricsServiceSetup, MetricsServiceStart, OpsMetrics, } from './types'; -export { OpsProcessMetrics, OpsServerMetrics, OpsOsMetrics } from './collectors'; +export type { OpsProcessMetrics, OpsServerMetrics, OpsOsMetrics } from './collectors'; export { MetricsService } from './metrics_service'; export { opsConfig } from './ops_config'; diff --git a/src/core/server/plugins/index.ts b/src/core/server/plugins/index.ts index e4dd15fa9ff02..a71df00b39c5c 100644 --- a/src/core/server/plugins/index.ts +++ b/src/core/server/plugins/index.ts @@ -6,12 +6,8 @@ * Side Public License, v 1. */ -export { - PluginsService, - PluginsServiceSetup, - PluginsServiceStart, - UiPlugins, -} from './plugins_service'; +export { PluginsService } from './plugins_service'; +export type { PluginsServiceSetup, PluginsServiceStart, UiPlugins } from './plugins_service'; export { config } from './plugins_config'; /** @internal */ export { isNewPlatformPlugin } from './discovery'; diff --git a/src/core/server/saved_objects/export/index.ts b/src/core/server/saved_objects/export/index.ts index dce1c048f252c..4af184e54b49c 100644 --- a/src/core/server/saved_objects/export/index.ts +++ b/src/core/server/saved_objects/export/index.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export { +export type { SavedObjectsExportByObjectOptions, SavedObjectExportBaseOptions, SavedObjectsExportByTypeOptions, @@ -14,5 +14,6 @@ export { SavedObjectsExportTransformContext, SavedObjectsExportTransform, } from './types'; -export { ISavedObjectsExporter, SavedObjectsExporter } from './saved_objects_exporter'; +export { SavedObjectsExporter } from './saved_objects_exporter'; +export type { ISavedObjectsExporter } from './saved_objects_exporter'; export { SavedObjectsExportError } from './errors'; diff --git a/src/core/server/saved_objects/import/index.ts b/src/core/server/saved_objects/import/index.ts index 2f172deedd110..4832038b342d2 100644 --- a/src/core/server/saved_objects/import/index.ts +++ b/src/core/server/saved_objects/import/index.ts @@ -6,8 +6,9 @@ * Side Public License, v 1. */ -export { ISavedObjectsImporter, SavedObjectsImporter } from './saved_objects_importer'; -export { +export { SavedObjectsImporter } from './saved_objects_importer'; +export type { ISavedObjectsImporter } from './saved_objects_importer'; +export type { SavedObjectsImportResponse, SavedObjectsImportSuccess, SavedObjectsImportFailure, diff --git a/src/core/server/saved_objects/index.ts b/src/core/server/saved_objects/index.ts index 48ae57c509daf..2af25e0cdef3f 100644 --- a/src/core/server/saved_objects/index.ts +++ b/src/core/server/saved_objects/index.ts @@ -8,9 +8,10 @@ export * from './service'; -export { +export { SavedObjectsImporter } from './import'; + +export type { ISavedObjectsImporter, - SavedObjectsImporter, SavedObjectsImportAmbiguousConflictError, SavedObjectsImportConflictError, SavedObjectsImportFailure, @@ -30,7 +31,7 @@ export { SavedObjectsImportWarning, } from './import'; -export { +export type { SavedObjectsExporter, ISavedObjectsExporter, SavedObjectExportBaseOptions, @@ -42,18 +43,20 @@ export { SavedObjectsExportTransform, } from './export'; -export { - SavedObjectsSerializer, +export { SavedObjectsSerializer } from './serialization'; + +export type { SavedObjectsRawDoc, SavedObjectsRawDocParseOptions, SavedObjectSanitizedDoc, SavedObjectUnsanitizedDoc, } from './serialization'; -export { SavedObjectsMigrationLogger } from './migrations/core/migration_logger'; +export type { SavedObjectsMigrationLogger } from './migrations/core/migration_logger'; + +export { SavedObjectsService } from './saved_objects_service'; -export { - SavedObjectsService, +export type { InternalSavedObjectsServiceStart, SavedObjectsServiceStart, SavedObjectsServiceSetup, @@ -61,14 +64,14 @@ export { SavedObjectsRepositoryFactory, } from './saved_objects_service'; -export { +export type { ISavedObjectsRepository, SavedObjectsIncrementCounterOptions, SavedObjectsIncrementCounterField, SavedObjectsDeleteByNamespaceOptions, } from './service/lib/repository'; -export { +export type { SavedObjectsCoreFieldMapping, SavedObjectsComplexFieldMapping, SavedObjectsFieldMapping, @@ -77,13 +80,13 @@ export { SavedObjectsTypeMappingDefinitions, } from './mappings'; -export { +export type { SavedObjectMigrationMap, SavedObjectMigrationFn, SavedObjectMigrationContext, } from './migrations'; -export { +export type { SavedObjectsNamespaceType, SavedObjectStatusMeta, SavedObjectsType, @@ -91,4 +94,5 @@ export { } from './types'; export { savedObjectsConfig, savedObjectsMigrationConfig } from './saved_objects_config'; -export { SavedObjectTypeRegistry, ISavedObjectTypeRegistry } from './saved_objects_type_registry'; +export { SavedObjectTypeRegistry } from './saved_objects_type_registry'; +export type { ISavedObjectTypeRegistry } from './saved_objects_type_registry'; diff --git a/src/core/server/saved_objects/mappings/index.ts b/src/core/server/saved_objects/mappings/index.ts index deb0c213cc0c4..bf1029e9f3b81 100644 --- a/src/core/server/saved_objects/mappings/index.ts +++ b/src/core/server/saved_objects/mappings/index.ts @@ -7,7 +7,7 @@ */ export { getTypes, getProperty, getRootProperties, getRootPropertiesObjects } from './lib'; -export { +export type { SavedObjectsComplexFieldMapping, SavedObjectsCoreFieldMapping, SavedObjectsTypeMappingDefinition, diff --git a/src/core/server/saved_objects/migrations/core/index.ts b/src/core/server/saved_objects/migrations/core/index.ts index b2f616ec31e68..322150e2b850e 100644 --- a/src/core/server/saved_objects/migrations/core/index.ts +++ b/src/core/server/saved_objects/migrations/core/index.ts @@ -9,7 +9,8 @@ export { DocumentMigrator } from './document_migrator'; export { IndexMigrator } from './index_migrator'; export { buildActiveMappings } from './build_active_mappings'; -export { CallCluster } from './call_cluster'; -export { LogFn, SavedObjectsMigrationLogger } from './migration_logger'; -export { MigrationResult, MigrationStatus } from './migration_coordinator'; -export { createMigrationEsClient, MigrationEsClient } from './migration_es_client'; +export type { CallCluster } from './call_cluster'; +export type { LogFn, SavedObjectsMigrationLogger } from './migration_logger'; +export type { MigrationResult, MigrationStatus } from './migration_coordinator'; +export { createMigrationEsClient } from './migration_es_client'; +export type { MigrationEsClient } from './migration_es_client'; diff --git a/src/core/server/saved_objects/migrations/index.ts b/src/core/server/saved_objects/migrations/index.ts index a0eea21c567de..20b86ee6d3739 100644 --- a/src/core/server/saved_objects/migrations/index.ts +++ b/src/core/server/saved_objects/migrations/index.ts @@ -6,9 +6,10 @@ * Side Public License, v 1. */ -export { MigrationResult } from './core'; -export { KibanaMigrator, IKibanaMigrator } from './kibana'; -export { +export type { MigrationResult } from './core'; +export { KibanaMigrator } from './kibana'; +export type { IKibanaMigrator } from './kibana'; +export type { SavedObjectMigrationFn, SavedObjectMigrationMap, SavedObjectMigrationContext, diff --git a/src/core/server/saved_objects/migrations/kibana/index.ts b/src/core/server/saved_objects/migrations/kibana/index.ts index fff72409e7c12..52755ee0aed71 100644 --- a/src/core/server/saved_objects/migrations/kibana/index.ts +++ b/src/core/server/saved_objects/migrations/kibana/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export { KibanaMigrator, IKibanaMigrator, KibanaMigratorStatus } from './kibana_migrator'; +export { KibanaMigrator } from './kibana_migrator'; +export type { IKibanaMigrator, KibanaMigratorStatus } from './kibana_migrator'; diff --git a/src/core/server/saved_objects/migrationsv2/actions/index.ts b/src/core/server/saved_objects/migrationsv2/actions/index.ts index b22c326061f66..d025f104c6e3f 100644 --- a/src/core/server/saved_objects/migrationsv2/actions/index.ts +++ b/src/core/server/saved_objects/migrationsv2/actions/index.ts @@ -20,7 +20,7 @@ import { catchRetryableEsClientErrors, RetryableEsClientError, } from './catch_retryable_es_client_errors'; -export { RetryableEsClientError }; +export type { RetryableEsClientError }; export const isRetryableEsClientResponse = ( res: Either.Either diff --git a/src/core/server/saved_objects/object_types/index.ts b/src/core/server/saved_objects/object_types/index.ts index 0907980e8773a..11a2c1973b09a 100644 --- a/src/core/server/saved_objects/object_types/index.ts +++ b/src/core/server/saved_objects/object_types/index.ts @@ -7,5 +7,5 @@ */ export { LEGACY_URL_ALIAS_TYPE } from './constants'; -export { LegacyUrlAlias } from './types'; +export type { LegacyUrlAlias } from './types'; export { registerCoreObjectTypes } from './registration'; diff --git a/src/core/server/saved_objects/serialization/index.ts b/src/core/server/saved_objects/serialization/index.ts index 2a15de494daae..64055f52adebb 100644 --- a/src/core/server/saved_objects/serialization/index.ts +++ b/src/core/server/saved_objects/serialization/index.ts @@ -11,7 +11,7 @@ * the raw document format as stored in ElasticSearch. */ -export { +export type { SavedObjectUnsanitizedDoc, SavedObjectSanitizedDoc, SavedObjectsRawDoc, diff --git a/src/core/server/saved_objects/service/index.ts b/src/core/server/saved_objects/service/index.ts index b7856f7b91204..1186e15cbef4a 100644 --- a/src/core/server/saved_objects/service/index.ts +++ b/src/core/server/saved_objects/service/index.ts @@ -5,18 +5,15 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - -export { +export { SavedObjectsErrorHelpers, SavedObjectsClientProvider, SavedObjectsUtils } from './lib'; +export type { SavedObjectsRepository, - SavedObjectsClientProvider, ISavedObjectsClientProvider, SavedObjectsClientProviderOptions, SavedObjectsClientWrapperFactory, SavedObjectsClientWrapperOptions, - SavedObjectsErrorHelpers, SavedObjectsClientFactory, SavedObjectsClientFactoryProvider, - SavedObjectsUtils, } from './lib'; export * from './saved_objects_client'; diff --git a/src/core/server/saved_objects/service/lib/index.ts b/src/core/server/saved_objects/service/lib/index.ts index 4742f7fed19ab..d05552bc6e55e 100644 --- a/src/core/server/saved_objects/service/lib/index.ts +++ b/src/core/server/saved_objects/service/lib/index.ts @@ -6,13 +6,12 @@ * Side Public License, v 1. */ -export { ISavedObjectsRepository, SavedObjectsRepository } from './repository'; - -export { +export type { ISavedObjectsRepository, SavedObjectsRepository } from './repository'; +export { SavedObjectsClientProvider } from './scoped_client_provider'; +export type { SavedObjectsClientWrapperFactory, SavedObjectsClientWrapperOptions, ISavedObjectsClientProvider, - SavedObjectsClientProvider, SavedObjectsClientProviderOptions, SavedObjectsClientFactory, SavedObjectsClientFactoryProvider, diff --git a/src/core/server/saved_objects/types.ts b/src/core/server/saved_objects/types.ts index 57a77a9ebc525..11a694c72f29f 100644 --- a/src/core/server/saved_objects/types.ts +++ b/src/core/server/saved_objects/types.ts @@ -12,7 +12,7 @@ import { SavedObjectMigrationMap } from './migrations'; import { SavedObjectsExportTransform } from './export'; import { SavedObjectsImportHook } from './import/types'; -export { +export type { SavedObjectsImportResponse, SavedObjectsImportSuccess, SavedObjectsImportConflictError, @@ -31,7 +31,7 @@ import { SavedObject } from '../../types'; type KueryNode = any; -export { +export type { SavedObjectAttributes, SavedObjectAttribute, SavedObjectAttributeSingle, diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 72d66bc04f08e..15adae32cca6d 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -924,16 +924,6 @@ export interface ErrorHttpResponseOptions { headers?: ResponseHeaders; } -// @public (undocumented) -export interface Explanation { - // (undocumented) - description: string; - // (undocumented) - details: Explanation[]; - // (undocumented) - value: number; -} - // @public export interface FakeRequest { headers: Headers; @@ -3198,6 +3188,7 @@ export const validBodyOutput: readonly ["data", "stream"]; // Warnings were encountered during analysis: // +// src/core/server/elasticsearch/client/types.ts:94:7 - (ae-forgotten-export) The symbol "Explanation" needs to be exported by the entry point index.d.ts // src/core/server/http/router/response.ts:297:3 - (ae-forgotten-export) The symbol "KibanaResponse" needs to be exported by the entry point index.d.ts // src/core/server/plugins/types.ts:286:3 - (ae-forgotten-export) The symbol "KibanaConfigType" needs to be exported by the entry point index.d.ts // src/core/server/plugins/types.ts:286:3 - (ae-forgotten-export) The symbol "SharedGlobalConfigKeys" needs to be exported by the entry point index.d.ts diff --git a/src/core/server/types.ts b/src/core/server/types.ts index 2ae51d4452a4e..6bd805d55af1d 100644 --- a/src/core/server/types.ts +++ b/src/core/server/types.ts @@ -7,7 +7,7 @@ */ /** This module is intended for consumption by public to avoid import issues with server-side code */ -export { PluginOpaqueId } from './plugins/types'; +export type { PluginOpaqueId } from './plugins/types'; export type { SavedObjectsImportResponse, SavedObjectsImportSuccess, diff --git a/src/core/server/ui_settings/index.ts b/src/core/server/ui_settings/index.ts index ae03040dd8407..ba5e952ff6fe5 100644 --- a/src/core/server/ui_settings/index.ts +++ b/src/core/server/ui_settings/index.ts @@ -6,12 +6,12 @@ * Side Public License, v 1. */ -export { UiSettingsClient, UiSettingsServiceOptions } from './ui_settings_client'; +export type { UiSettingsClient, UiSettingsServiceOptions } from './ui_settings_client'; export { config } from './ui_settings_config'; export { UiSettingsService } from './ui_settings_service'; -export { +export type { UiSettingsServiceSetup, UiSettingsServiceStart, IUiSettingsClient, diff --git a/src/core/server/ui_settings/types.ts b/src/core/server/ui_settings/types.ts index 39fecc7f5ecd4..0f13c82eed11a 100644 --- a/src/core/server/ui_settings/types.ts +++ b/src/core/server/ui_settings/types.ts @@ -8,7 +8,7 @@ import { SavedObjectsClientContract } from '../saved_objects/types'; import { UiSettingsParams, UserProvidedValues, PublicUiSettingsParams } from '../../types'; -export { +export type { UiSettingsParams, PublicUiSettingsParams, StringValidationRegexString, diff --git a/src/core/server/utils/crypto/index.ts b/src/core/server/utils/crypto/index.ts index fdea52f9e9782..7254e6a2411ac 100644 --- a/src/core/server/utils/crypto/index.ts +++ b/src/core/server/utils/crypto/index.ts @@ -6,5 +6,6 @@ * Side Public License, v 1. */ -export { Pkcs12ReadResult, readPkcs12Keystore, readPkcs12Truststore } from './pkcs12'; +export { readPkcs12Keystore, readPkcs12Truststore } from './pkcs12'; +export type { Pkcs12ReadResult } from './pkcs12'; export { createSHA256Hash } from './sha256'; diff --git a/src/core/tsconfig.json b/src/core/tsconfig.json index e8a82ee533f11..855962070457e 100644 --- a/src/core/tsconfig.json +++ b/src/core/tsconfig.json @@ -5,7 +5,8 @@ "outDir": "./target/types", "emitDeclarationOnly": true, "declaration": true, - "declarationMap": true + "declarationMap": true, + "isolatedModules": true, }, "include": [ "public/**/*", From dc6d0b7910e542f0dfeff49b1824baeff9a94dbb Mon Sep 17 00:00:00 2001 From: Zacqary Adam Xeper Date: Wed, 3 Mar 2021 10:39:38 -0600 Subject: [PATCH 4/7] [Metrics UI] Fix removing warning threshold from alert expressions (#93338) --- .../infra/public/alerting/inventory/components/expression.tsx | 2 +- .../public/alerting/metric_threshold/components/expression.tsx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/x-pack/plugins/infra/public/alerting/inventory/components/expression.tsx b/x-pack/plugins/infra/public/alerting/inventory/components/expression.tsx index d43bbb6888a6e..7233ce3de7497 100644 --- a/x-pack/plugins/infra/public/alerting/inventory/components/expression.tsx +++ b/x-pack/plugins/infra/public/alerting/inventory/components/expression.tsx @@ -137,7 +137,7 @@ export const Expressions: React.FC = (props) => { const updateParams = useCallback( (id, e: InventoryMetricConditions) => { const exp = alertParams.criteria ? alertParams.criteria.slice() : []; - exp[id] = { ...exp[id], ...e }; + exp[id] = e; setAlertParams('criteria', exp); }, [setAlertParams, alertParams.criteria] diff --git a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression.tsx b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression.tsx index b2cca858cec4b..3b8afc173c2bd 100644 --- a/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression.tsx +++ b/x-pack/plugins/infra/public/alerting/metric_threshold/components/expression.tsx @@ -98,7 +98,7 @@ export const Expressions: React.FC = (props) => { const updateParams = useCallback( (id, e: MetricExpression) => { const exp = alertParams.criteria ? alertParams.criteria.slice() : []; - exp[id] = { ...exp[id], ...e }; + exp[id] = e; setAlertParams('criteria', exp); }, [setAlertParams, alertParams.criteria] From 6467afa6156823dab8a4cd0c6be7cc2c19af244c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ece=20=C3=96zalp?= Date: Wed, 3 Mar 2021 11:55:11 -0500 Subject: [PATCH 5/7] [Security Solution] Updates redirect route upon rule creation (#92715) * [Security Solution] Updates redirect route upon rule creation Closes #82562. --- .../cypress/screens/create_new_rule.ts | 2 + .../cypress/tasks/create_new_rule.ts | 53 ++++++++++--------- .../rules/use_create_rule.test.tsx | 12 +++-- .../rules/use_create_rule.tsx | 15 +++--- .../detection_engine/rules/create/index.tsx | 9 ++-- 5 files changed, 52 insertions(+), 39 deletions(-) diff --git a/x-pack/plugins/security_solution/cypress/screens/create_new_rule.ts b/x-pack/plugins/security_solution/cypress/screens/create_new_rule.ts index 3c7da2e298847..b2b7e434348b4 100644 --- a/x-pack/plugins/security_solution/cypress/screens/create_new_rule.ts +++ b/x-pack/plugins/security_solution/cypress/screens/create_new_rule.ts @@ -26,6 +26,8 @@ export const ANOMALY_THRESHOLD_INPUT = '[data-test-subj="anomalyThresholdSlider" export const ADVANCED_SETTINGS_BTN = '[data-test-subj="advancedSettings"] .euiAccordion__button'; +export const BACK_TO_ALL_RULES_LINK = '[data-test-subj="ruleDetailsBackToAllRules"]'; + export const COMBO_BOX_CLEAR_BTN = '[data-test-subj="comboBoxClearButton"]'; export const COMBO_BOX_INPUT = '[data-test-subj="comboBoxInput"]'; diff --git a/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts b/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts index 11d98f7b808ed..b317f158ae614 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts @@ -21,25 +21,42 @@ import { ADD_REFERENCE_URL_BTN, ADVANCED_SETTINGS_BTN, ANOMALY_THRESHOLD_INPUT, + AT_LEAST_ONE_INDEX_PATTERN, + AT_LEAST_ONE_VALID_MATCH, + BACK_TO_ALL_RULES_LINK, + COMBO_BOX_CLEAR_BTN, COMBO_BOX_INPUT, CREATE_AND_ACTIVATE_BTN, CUSTOM_QUERY_INPUT, + CUSTOM_QUERY_REQUIRED, + DEFAULT_RISK_SCORE_INPUT, DEFINE_CONTINUE_BUTTON, DEFINE_EDIT_TAB, + EQL_QUERY_INPUT, + EQL_QUERY_PREVIEW_HISTOGRAM, + EQL_QUERY_VALIDATION_SPINNER, + EQL_TYPE, FALSE_POSITIVES_INPUT, IMPORT_QUERY_FROM_SAVED_TIMELINE_LINK, INDICATOR_MATCH_TYPE, INPUT, + INVALID_MATCH_CONTENT, INVESTIGATION_NOTES_TEXTAREA, LOOK_BACK_INTERVAL, LOOK_BACK_TIME_TYPE, MACHINE_LEARNING_DROPDOWN, MACHINE_LEARNING_LIST, MACHINE_LEARNING_TYPE, + MITRE_ATTACK_ADD_SUBTECHNIQUE_BUTTON, + MITRE_ATTACK_ADD_TACTIC_BUTTON, + MITRE_ATTACK_ADD_TECHNIQUE_BUTTON, + MITRE_ATTACK_SUBTECHNIQUE_DROPDOWN, + MITRE_ATTACK_TACTIC_DROPDOWN, + MITRE_ATTACK_TECHNIQUE_DROPDOWN, MITRE_TACTIC, + QUERY_PREVIEW_BUTTON, REFERENCE_URLS_INPUT, REFRESH_BUTTON, - DEFAULT_RISK_SCORE_INPUT, RISK_MAPPING_OVERRIDE_OPTION, RISK_OVERRIDE, RULE_DESCRIPTION_INPUT, @@ -47,6 +64,8 @@ import { RULE_NAME_OVERRIDE, RULE_STATUS, RULE_TIMESTAMP_OVERRIDE, + RULES_CREATION_FORM, + RULES_CREATION_PREVIEW, RUNS_EVERY_INTERVAL, RUNS_EVERY_TIME_TYPE, SCHEDULE_CONTINUE_BUTTON, @@ -55,36 +74,18 @@ import { SEVERITY_MAPPING_OVERRIDE_OPTION, SEVERITY_OVERRIDE_ROW, TAGS_INPUT, - THRESHOLD_FIELD_SELECTION, - THRESHOLD_INPUT_AREA, - THRESHOLD_TYPE, - EQL_TYPE, - EQL_QUERY_INPUT, - QUERY_PREVIEW_BUTTON, - EQL_QUERY_PREVIEW_HISTOGRAM, - EQL_QUERY_VALIDATION_SPINNER, - COMBO_BOX_CLEAR_BTN, - MITRE_ATTACK_TACTIC_DROPDOWN, - MITRE_ATTACK_TECHNIQUE_DROPDOWN, - MITRE_ATTACK_SUBTECHNIQUE_DROPDOWN, - MITRE_ATTACK_ADD_TACTIC_BUTTON, - MITRE_ATTACK_ADD_SUBTECHNIQUE_BUTTON, - MITRE_ATTACK_ADD_TECHNIQUE_BUTTON, THREAT_COMBO_BOX_INPUT, THREAT_ITEM_ENTRY_DELETE_BUTTON, + THREAT_MAPPING_COMBO_BOX_INPUT, THREAT_MATCH_AND_BUTTON, - INVALID_MATCH_CONTENT, - THREAT_MATCH_OR_BUTTON, - AT_LEAST_ONE_VALID_MATCH, - AT_LEAST_ONE_INDEX_PATTERN, - CUSTOM_QUERY_REQUIRED, - RULES_CREATION_FORM, - RULES_CREATION_PREVIEW, + THREAT_MATCH_CUSTOM_QUERY_INPUT, THREAT_MATCH_INDICATOR_INDEX, THREAT_MATCH_INDICATOR_INDICATOR_INDEX, - THREAT_MATCH_CUSTOM_QUERY_INPUT, + THREAT_MATCH_OR_BUTTON, THREAT_MATCH_QUERY_INPUT, - THREAT_MAPPING_COMBO_BOX_INPUT, + THRESHOLD_FIELD_SELECTION, + THRESHOLD_INPUT_AREA, + THRESHOLD_TYPE, } from '../screens/create_new_rule'; import { TOAST_ERROR } from '../screens/shared'; import { SERVER_SIDE_EVENT_COUNT } from '../screens/timeline'; @@ -95,6 +96,8 @@ export const createAndActivateRule = () => { cy.get(SCHEDULE_CONTINUE_BUTTON).click({ force: true }); cy.get(CREATE_AND_ACTIVATE_BTN).click({ force: true }); cy.get(CREATE_AND_ACTIVATE_BTN).should('not.exist'); + cy.get(BACK_TO_ALL_RULES_LINK).click({ force: true }); + cy.get(BACK_TO_ALL_RULES_LINK).should('not.exist'); }; export const fillAboutRule = ( diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.test.tsx b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.test.tsx index 7eb552bcbc2ee..0074808057ca7 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.test.tsx +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.test.tsx @@ -9,6 +9,7 @@ import { renderHook, act } from '@testing-library/react-hooks'; import { useCreateRule, ReturnCreateRule } from './use_create_rule'; import { getCreateRulesSchemaMock } from '../../../../../common/detection_engine/schemas/request/rule_schemas.mock'; +import { getRulesSchemaMock } from '../../../../../common/detection_engine/schemas/response/rules_schema.mocks'; jest.mock('./api'); @@ -16,7 +17,7 @@ describe('useCreateRule', () => { test('init', async () => { const { result } = renderHook(() => useCreateRule()); - expect(result.current).toEqual([{ isLoading: false, isSaved: false }, result.current[1]]); + expect(result.current).toEqual([{ isLoading: false, ruleId: null }, result.current[1]]); }); test('saving rule with isLoading === true', async () => { @@ -27,11 +28,11 @@ describe('useCreateRule', () => { await waitForNextUpdate(); result.current[1](getCreateRulesSchemaMock()); rerender(); - expect(result.current).toEqual([{ isLoading: true, isSaved: false }, result.current[1]]); + expect(result.current).toEqual([{ isLoading: true, ruleId: null }, result.current[1]]); }); }); - test('saved rule with isSaved === true', async () => { + test('updates ruleId after the rule has been saved', async () => { await act(async () => { const { result, waitForNextUpdate } = renderHook(() => useCreateRule() @@ -39,7 +40,10 @@ describe('useCreateRule', () => { await waitForNextUpdate(); result.current[1](getCreateRulesSchemaMock()); await waitForNextUpdate(); - expect(result.current).toEqual([{ isLoading: false, isSaved: true }, result.current[1]]); + expect(result.current).toEqual([ + { isLoading: false, ruleId: getRulesSchemaMock().id }, + result.current[1], + ]); }); }); }); diff --git a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.tsx b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.tsx index 1a31654bf311e..e9a807d772d8b 100644 --- a/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.tsx +++ b/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules/use_create_rule.tsx @@ -16,28 +16,31 @@ import { transformOutput } from './transforms'; interface CreateRuleReturn { isLoading: boolean; - isSaved: boolean; + ruleId: string | null; } export type ReturnCreateRule = [CreateRuleReturn, Dispatch]; export const useCreateRule = (): ReturnCreateRule => { const [rule, setRule] = useState(null); - const [isSaved, setIsSaved] = useState(false); + const [ruleId, setRuleId] = useState(null); const [isLoading, setIsLoading] = useState(false); const [, dispatchToaster] = useStateToaster(); useEffect(() => { let isSubscribed = true; const abortCtrl = new AbortController(); - setIsSaved(false); + setRuleId(null); const saveRule = async () => { if (rule != null) { try { setIsLoading(true); - await createRule({ rule: transformOutput(rule), signal: abortCtrl.signal }); + const createRuleResponse = await createRule({ + rule: transformOutput(rule), + signal: abortCtrl.signal, + }); if (isSubscribed) { - setIsSaved(true); + setRuleId(createRuleResponse.id); } } catch (error) { if (isSubscribed) { @@ -57,5 +60,5 @@ export const useCreateRule = (): ReturnCreateRule => { }; }, [rule, dispatchToaster]); - return [{ isLoading, isSaved }, setRule]; + return [{ isLoading, ruleId }, setRule]; }; diff --git a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx index 58d6bccd52785..deebe26fe4a51 100644 --- a/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules/create/index.tsx @@ -22,8 +22,9 @@ import { CreateRulesSchema } from '../../../../../../common/detection_engine/sch import { useListsConfig } from '../../../../containers/detection_engine/lists/use_lists_config'; import { - getRulesUrl, getDetectionEngineUrl, + getRuleDetailsUrl, + getRulesUrl, } from '../../../../../common/components/link_to/redirect_to_detection_engine'; import { WrapperPage } from '../../../../../common/components/wrapper_page'; import { displaySuccessToast, useStateToaster } from '../../../../../common/components/toasters'; @@ -138,7 +139,7 @@ const CreateRulePageComponent: React.FC = () => { [RuleStep.scheduleRule]: false, [RuleStep.ruleActions]: false, }); - const [{ isLoading, isSaved }, setRule] = useCreateRule(); + const [{ isLoading, ruleId }, setRule] = useCreateRule(); const ruleType = stepsData.current[RuleStep.defineRule].data?.ruleType; const ruleName = stepsData.current[RuleStep.aboutRule].data?.name; const actionMessageParams = useMemo(() => getActionMessageParams(ruleType), [ruleType]); @@ -263,9 +264,9 @@ const CreateRulePageComponent: React.FC = () => { /> ); - if (isSaved && ruleName) { + if (ruleName && ruleId) { displaySuccessToast(i18n.SUCCESSFULLY_CREATED_RULES(ruleName), dispatchToaster); - history.replace(getRulesUrl()); + history.replace(getRuleDetailsUrl(ruleId)); return null; } From 73f8b335e198dcb05915dfcc3fbc4dba3a4712c7 Mon Sep 17 00:00:00 2001 From: Joe Reuter Date: Wed, 3 Mar 2021 17:56:26 +0100 Subject: [PATCH 6/7] [Lens] Add retry and remove unused test (#93233) --- .../test/functional/apps/lens/smokescreen.ts | 38 ------------------- x-pack/test/functional/apps/lens/table.ts | 8 ++-- 2 files changed, 5 insertions(+), 41 deletions(-) diff --git a/x-pack/test/functional/apps/lens/smokescreen.ts b/x-pack/test/functional/apps/lens/smokescreen.ts index 3e9ffa18c5949..bf79ac996f8ec 100644 --- a/x-pack/test/functional/apps/lens/smokescreen.ts +++ b/x-pack/test/functional/apps/lens/smokescreen.ts @@ -12,7 +12,6 @@ import { FtrProviderContext } from '../../ftr_provider_context'; export default function ({ getService, getPageObjects }: FtrProviderContext) { const PageObjects = getPageObjects(['visualize', 'lens', 'common', 'header']); const find = getService('find'); - const retry = getService('retry'); const listingTable = getService('listingTable'); const testSubjects = getService('testSubjects'); const elasticChart = getService('elasticChart'); @@ -600,42 +599,5 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { }); expect(await testSubjects.isEnabled('lnsApp_downloadCSVButton')).to.eql(true); }); - - it('should able to sort a table by a column', async () => { - await PageObjects.visualize.gotoVisualizationLandingPage(); - await listingTable.searchForItemWithName('lnsXYvis'); - await PageObjects.lens.clickVisualizeListItemTitle('lnsXYvis'); - await PageObjects.lens.goToTimeRange(); - await PageObjects.lens.switchToVisualization('lnsDatatable'); - // Sort by number - await PageObjects.lens.changeTableSortingBy(2, 'ascending'); - await PageObjects.header.waitUntilLoadingHasFinished(); - expect(await PageObjects.lens.getDatatableCellText(0, 2)).to.eql('17,246'); - // Now sort by IP - await PageObjects.lens.changeTableSortingBy(0, 'ascending'); - await PageObjects.header.waitUntilLoadingHasFinished(); - expect(await PageObjects.lens.getDatatableCellText(0, 0)).to.eql('78.83.247.30'); - // Change the sorting - await PageObjects.lens.changeTableSortingBy(0, 'descending'); - await PageObjects.header.waitUntilLoadingHasFinished(); - expect(await PageObjects.lens.getDatatableCellText(0, 0)).to.eql('169.228.188.120'); - // Remove the sorting - await PageObjects.lens.changeTableSortingBy(0, 'none'); - await PageObjects.header.waitUntilLoadingHasFinished(); - expect(await PageObjects.lens.isDatatableHeaderSorted(0)).to.eql(false); - }); - - it('should able to use filters cell actions in table', async () => { - const firstCellContent = await PageObjects.lens.getDatatableCellText(0, 0); - await retry.try(async () => { - await PageObjects.lens.clickTableCellAction(0, 0, 'lensDatatableFilterOut'); - await PageObjects.header.waitUntilLoadingHasFinished(); - expect( - await find.existsByCssSelector( - `[data-test-subj*="filter-value-${firstCellContent}"][data-test-subj*="filter-negated"]` - ) - ).to.eql(true); - }); - }); }); } diff --git a/x-pack/test/functional/apps/lens/table.ts b/x-pack/test/functional/apps/lens/table.ts index 211669e75dc3f..7326aa24304a3 100644 --- a/x-pack/test/functional/apps/lens/table.ts +++ b/x-pack/test/functional/apps/lens/table.ts @@ -34,9 +34,11 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { await PageObjects.header.waitUntilLoadingHasFinished(); expect(await PageObjects.lens.getDatatableCellText(0, 0)).to.eql('169.228.188.120'); // Remove the sorting - await PageObjects.lens.changeTableSortingBy(0, 'none'); - await PageObjects.header.waitUntilLoadingHasFinished(); - expect(await PageObjects.lens.isDatatableHeaderSorted(0)).to.eql(false); + await retry.try(async () => { + await PageObjects.lens.changeTableSortingBy(0, 'none'); + await PageObjects.header.waitUntilLoadingHasFinished(); + expect(await PageObjects.lens.isDatatableHeaderSorted(0)).to.eql(false); + }); }); it('should able to use filters cell actions in table', async () => { From a0881f90e21570ba529487557728aa10b34c657d Mon Sep 17 00:00:00 2001 From: Rashmi Kulkarni Date: Wed, 3 Mar 2021 09:01:54 -0800 Subject: [PATCH 7/7] Test huge fields functional test (#93334) * fixes https://github.com/elastic/kibana/issues/74449 * fix for unskipping test huge fields functional test * fix eslint --- .../apps/management/_test_huge_fields.js | 6 +++--- .../es_archiver/large_fields/data.json.gz | Bin 48347 -> 48347 bytes 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/test/functional/apps/management/_test_huge_fields.js b/test/functional/apps/management/_test_huge_fields.js index 3102becbe181f..b9c9e964ac3f5 100644 --- a/test/functional/apps/management/_test_huge_fields.js +++ b/test/functional/apps/management/_test_huge_fields.js @@ -13,15 +13,15 @@ export default function ({ getService, getPageObjects }) { const security = getService('security'); const PageObjects = getPageObjects(['common', 'home', 'settings']); - // Failing: See https://github.com/elastic/kibana/issues/89031 - describe.skip('test large number of fields', function () { + describe('test large number of fields', function () { this.tags(['skipCloud']); const EXPECTED_FIELD_COUNT = '10006'; before(async function () { - await security.testUser.setRoles(['kibana_admin', 'test_testhuge_reader']); + await security.testUser.setRoles(['kibana_admin', 'test_testhuge_reader'], false); await esArchiver.emptyKibanaIndex(); await esArchiver.loadIfNeeded('large_fields'); + await PageObjects.settings.navigateTo(); await PageObjects.settings.createIndexPattern('testhuge', 'date'); }); diff --git a/test/functional/fixtures/es_archiver/large_fields/data.json.gz b/test/functional/fixtures/es_archiver/large_fields/data.json.gz index e3879e288b6f21c93ac50be1f78fee8e15448b50..ff82acd5842ee4d20e384c929142bf63a56a8ce5 100644 GIT binary patch delta 282 zcmV+#0p{!60=iPf0g03x~7!mwQjl&ZV)D7E! zZ5dKau%OAizk1h!;qwA@Q=4Ze$w+cBb|$%=|KtDk-~2cK?SJ{-|KI=lzy0t3oB#Gd z{ZIenfBS#_k01PR|HJ>|fBlc2{2%}IfBx(L{@?%8e=NQJU4Ql;|NH;?PyhM<^B+I? zFaP;}`7i&s|Mma+pZ_fQU;d~6^?&{!|9`*tUw`tS{)hka?-q1lfBw6F?*GfR z|NftU{_B6|m;UQN`hWiK|J(oYKmYSz|JgtP|3A9^>yNI#e)J#z?E3rP{licF{!5T=e@fX!g-c}VnpzgYKJ=@NC&n7 z+cI>61$Ex%uQ9g`?*Y_HE$)>hBgx5FndJQbkN?wu^M-LkN@&N|K)%GhyU(>`FDB#xqqJj=KANq`RD#WU;A(W z`RBj<_wT>|FaPBK_CNf`Ke+zC|NH;^AO7?I`#*m2zx?O_`G5Jp{;&U+|NLjc|NKAx zum973|NndG|MHXn$N&Dn{dfPPx#