[Entity Analytics] Move all entity analytics API schemas into `entity…

…_analytics` folder. (#172363) ## Summary Create `security_solution/common/api/entity_analytics` to house all entity analytics related apis, in this case `risk_score`, `risk_engine` and `asset_criticality`. This makes ownership clearer, simplifies the codeowners file, and will enable the entity analytics team to have shared schema components in `security_solution/common/api/entity_analytics/common` (something I want to do in an upcoming PR) I have removed `@elastic/security-threat-hunting-explore`'s ownersip of `/x-pack/plugins/security_solution/common/api/risk_score` let me know if you want to keep it!
elastic · Dec 1, 2023 · 18f8a95 · 18f8a95
1 parent 59982bf
commit 18f8a95
Show file tree

Hide file tree

Showing 45 changed files with 20 additions and 21 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1267,7 +1267,6 @@ x-pack/test/security_solution_cypress/cypress/tasks/expandable_flyout  @elastic/
 
 ## Security Solution sub teams - Threat Hunting Explore
 /x-pack/plugins/security_solution/common/api/tags @elastic/security-threat-hunting-explore
-/x-pack/plugins/security_solution/common/api/risk_score @elastic/security-threat-hunting-explore
 /x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts @elastic/security-threat-hunting-explore
 /x-pack/plugins/security_solution/common/search_strategy/security_solution/matrix_histogram @elastic/security-threat-hunting-explore
 /x-pack/plugins/security_solution/common/search_strategy/security_solution/network @elastic/security-threat-hunting-explore
@@ -1475,7 +1474,7 @@ x-pack/plugins/security_solution/server/lib/entity_analytics @elastic/security-e
 x-pack/plugins/security_solution/server/lib/risk_score @elastic/security-entity-analytics
 x-pack/test/security_solution_api_integration/test_suites/entity_analytics @elastic/security-entity-analytics
 x-pack/plugins/security_solution/public/flyout/entity_details @elastic/security-entity-analytics
-x-pack/plugins/security_solution/common/api/asset_criticality @elastic/security-entity-analytics
+x-pack/plugins/security_solution/common/api/entity_analytics @elastic/security-entity-analytics
 /x-pack/plugins/security_solution/public/entity_analytics @elastic/security-entity-analytics
 /x-pack/test/security_solution_cypress/cypress/e2e/entity_analytics @elastic/security-entity-analytics
 

diff --git a/...ommon/api/asset_criticality/common.gen.ts → ...analytics/asset_criticality/common.gen.ts b/...ommon/api/asset_criticality/common.gen.ts → ...analytics/asset_criticality/common.gen.ts
diff --git a/.../api/asset_criticality/common.schema.yaml → ...tics/asset_criticality/common.schema.yaml b/.../api/asset_criticality/common.schema.yaml → ...tics/asset_criticality/common.schema.yaml
diff --git a/...lity/create_asset_criticality.schema.yaml → ...lity/create_asset_criticality.schema.yaml b/...lity/create_asset_criticality.schema.yaml → ...lity/create_asset_criticality.schema.yaml
diff --git a/...lity/delete_asset_criticality.schema.yaml → ...lity/delete_asset_criticality.schema.yaml b/...lity/delete_asset_criticality.schema.yaml → ...lity/delete_asset_criticality.schema.yaml
diff --git a/...icality/get_asset_criticality.schema.yaml → ...icality/get_asset_criticality.schema.yaml b/...icality/get_asset_criticality.schema.yaml → ...icality/get_asset_criticality.schema.yaml
diff --git a/...ality/get_asset_criticality_status.gen.ts → ...ality/get_asset_criticality_status.gen.ts b/...ality/get_asset_criticality_status.gen.ts → ...ality/get_asset_criticality_status.gen.ts
diff --git a/.../get_asset_criticality_status.schema.yaml → .../get_asset_criticality_status.schema.yaml b/.../get_asset_criticality_status.schema.yaml → .../get_asset_criticality_status.schema.yaml
diff --git a/...ion/common/api/asset_criticality/index.ts → ...tity_analytics/asset_criticality/index.ts b/...ion/common/api/asset_criticality/index.ts → ...tity_analytics/asset_criticality/index.ts
diff --git a/.../risk_engine/calculation_route_schema.yml → .../risk_engine/calculation_route_schema.yml b/.../risk_engine/calculation_route_schema.yml → .../risk_engine/calculation_route_schema.yml
diff --git a/...olution/common/api/risk_engine/common.yml → ...i/entity_analytics/risk_engine/common.yml b/...olution/common/api/risk_engine/common.yml → ...i/entity_analytics/risk_engine/common.yml
diff --git a/...sk_engine/engine_disable_route_schema.yml → ...sk_engine/engine_disable_route_schema.yml b/...sk_engine/engine_disable_route_schema.yml → ...sk_engine/engine_disable_route_schema.yml
diff --git a/...isk_engine/engine_enable_route_schema.yml → ...isk_engine/engine_enable_route_schema.yml b/...isk_engine/engine_enable_route_schema.yml → ...isk_engine/engine_enable_route_schema.yml
diff --git a/.../risk_engine/engine_init_route_schema.yml → .../risk_engine/engine_init_route_schema.yml b/.../risk_engine/engine_init_route_schema.yml → .../risk_engine/engine_init_route_schema.yml
diff --git a/...isk_engine/engine_status_route_schema.yml → ...isk_engine/engine_status_route_schema.yml b/...isk_engine/engine_status_route_schema.yml → ...isk_engine/engine_status_route_schema.yml
diff --git a/.../api/risk_engine/preview_route_schema.yml → ...tics/risk_engine/preview_route_schema.yml b/.../api/risk_engine/preview_route_schema.yml → ...tics/risk_engine/preview_route_schema.yml
diff --git a/..._score/create_index/create_index_route.ts → ..._score/create_index/create_index_route.ts b/..._score/create_index/create_index_route.ts → ..._score/create_index/create_index_route.ts
diff --git a/...eate_prebuilt_saved_objects_route.test.ts → ...eate_prebuilt_saved_objects_route.test.ts b/...eate_prebuilt_saved_objects_route.test.ts → ...eate_prebuilt_saved_objects_route.test.ts
diff --git a/...ts/create_prebuilt_saved_objects_route.ts → ...ts/create_prebuilt_saved_objects_route.ts b/...ts/create_prebuilt_saved_objects_route.ts → ...ts/create_prebuilt_saved_objects_route.ts
diff --git a/...ored_script/create_stored_script_route.ts → ...ored_script/create_stored_script_route.ts b/...ored_script/create_stored_script_route.ts → ...ored_script/create_stored_script_route.ts
diff --git a/...re/delete_indices/delete_indices_route.ts → ...re/delete_indices/delete_indices_route.ts b/...re/delete_indices/delete_indices_route.ts → ...re/delete_indices/delete_indices_route.ts
diff --git a/...ts/delete_prebuilt_saved_objects_route.ts → ...ts/delete_prebuilt_saved_objects_route.ts b/...ts/delete_prebuilt_saved_objects_route.ts → ...ts/delete_prebuilt_saved_objects_route.ts
diff --git a/...ored_script/delete_stored_script_route.ts → ...ored_script/delete_stored_script_route.ts b/...ored_script/delete_stored_script_route.ts → ...ored_script/delete_stored_script_route.ts
diff --git a/...y_solution/common/api/risk_score/index.ts → .../api/entity_analytics/risk_score/index.ts b/...y_solution/common/api/risk_score/index.ts → .../api/entity_analytics/risk_score/index.ts
diff --git a/..._score/index_status/index_status_route.ts → ..._score/index_status/index_status_route.ts b/..._score/index_status/index_status_route.ts → ..._score/index_status/index_status_route.ts
diff --git a/.../install_modules/install_modules_route.ts → .../install_modules/install_modules_route.ts b/.../install_modules/install_modules_route.ts → .../install_modules/install_modules_route.ts
@@ -6,7 +6,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import { RiskScoreEntity } from '../../../search_strategy';
+import { RiskScoreEntity } from '../../../../search_strategy';
 
 export const onboardingRiskScoreRequestBody = {
   body: schema.object({

diff --git a/...t/read_prebuilt_dev_tool_content_route.ts → ...t/read_prebuilt_dev_tool_content_route.ts b/...t/read_prebuilt_dev_tool_content_route.ts → ...t/read_prebuilt_dev_tool_content_route.ts
diff --git a/...y_solution/server/lib/entity_analytics/asset_criticality/asset_criticality_data_client.ts b/...y_solution/server/lib/entity_analytics/asset_criticality/asset_criticality_data_client.ts
@@ -6,7 +6,7 @@
  */
 import type { Logger, ElasticsearchClient } from '@kbn/core/server';
 import { mappingFromFieldMap } from '@kbn/alerting-plugin/common';
-import type { AssetCriticalityRecord } from '../../../../common/api/asset_criticality';
+import type { AssetCriticalityRecord } from '../../../../common/api/entity_analytics/asset_criticality';
 import { createOrUpdateIndex } from '../utils/create_or_update_index';
 import { getAssetCriticalityIndex } from '../../../../common/asset_criticality';
 import { assetCriticalityFieldMap } from './configurations';

diff --git a/.../plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/delete.ts b/.../plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/delete.ts
@@ -9,7 +9,7 @@ import { buildSiemResponse } from '@kbn/lists-plugin/server/routes/utils';
 import { transformError } from '@kbn/securitysolution-es-utils';
 import { ASSET_CRITICALITY_URL, APP_ID } from '../../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
-import { AssetCriticalityRecordIdParts } from '../../../../../common/api/asset_criticality';
+import { AssetCriticalityRecordIdParts } from '../../../../../common/api/entity_analytics/asset_criticality';
 import { buildRouteValidationWithZod } from '../../../../utils/build_validation/route_validation';
 import { checkAndInitAssetCriticalityResources } from '../check_and_init_asset_criticality_resources';
 export const assetCriticalityDeleteRoute = (

diff --git a/x-pack/plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/get.ts b/x-pack/plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/get.ts
@@ -11,7 +11,7 @@ import { ASSET_CRITICALITY_URL, APP_ID } from '../../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { checkAndInitAssetCriticalityResources } from '../check_and_init_asset_criticality_resources';
 import { buildRouteValidationWithZod } from '../../../../utils/build_validation/route_validation';
-import { AssetCriticalityRecordIdParts } from '../../../../../common/api/asset_criticality';
+import { AssetCriticalityRecordIdParts } from '../../../../../common/api/entity_analytics/asset_criticality';
 export const assetCriticalityGetRoute = (router: SecuritySolutionPluginRouter, logger: Logger) => {
   router.versioned
     .get({

diff --git a/.../plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/status.ts b/.../plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/status.ts
@@ -7,7 +7,7 @@
 import type { Logger } from '@kbn/core/server';
 import { buildSiemResponse } from '@kbn/lists-plugin/server/routes/utils';
 import { transformError } from '@kbn/securitysolution-es-utils';
-import type { AssetCriticalityStatusResponse } from '../../../../../common/api/asset_criticality';
+import type { AssetCriticalityStatusResponse } from '../../../../../common/api/entity_analytics/asset_criticality';
 import { ASSET_CRITICALITY_STATUS_URL, APP_ID } from '../../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { checkAndInitAssetCriticalityResources } from '../check_and_init_asset_criticality_resources';

diff --git a/.../plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/upsert.ts b/.../plugins/security_solution/server/lib/entity_analytics/asset_criticality/routes/upsert.ts
@@ -11,7 +11,7 @@ import { ASSET_CRITICALITY_URL, APP_ID } from '../../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { checkAndInitAssetCriticalityResources } from '../check_and_init_asset_criticality_resources';
 import { buildRouteValidationWithZod } from '../../../../utils/build_validation/route_validation';
-import { CreateAssetCriticalityRecord } from '../../../../../common/api/asset_criticality';
+import { CreateAssetCriticalityRecord } from '../../../../../common/api/entity_analytics/asset_criticality';
 export const assetCriticalityUpsertRoute = (
   router: SecuritySolutionPluginRouter,
   logger: Logger

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/index_status/index.ts b/x-pack/plugins/security_solution/server/lib/risk_score/index_status/index.ts
@@ -11,7 +11,7 @@ import { APP_ID, RISK_SCORE_INDEX_STATUS_API_URL } from '../../../../common/cons
 import type { SecuritySolutionPluginRouter } from '../../../types';
 import { buildRouteValidation } from '../../../utils/build_validation/route_validation';
 import { buildSiemResponse } from '../../detection_engine/routes/utils';
-import { indexStatusRequestQuery } from '../../../../common/api/risk_score';
+import { indexStatusRequestQuery } from '../../../../common/api/entity_analytics/risk_score';
 
 export const getRiskScoreIndexStatusRoute = (router: SecuritySolutionPluginRouter) => {
   router.versioned

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/indices/create_index_route.ts b/x-pack/plugins/security_solution/server/lib/risk_score/indices/create_index_route.ts
@@ -12,7 +12,7 @@ import { transformError } from '@kbn/securitysolution-es-utils';
 import { RISK_SCORE_CREATE_INDEX } from '../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../types';
 import { createIndex } from './lib/create_index';
-import { createEsIndexRequestBody } from '../../../../common/api/risk_score';
+import { createEsIndexRequestBody } from '../../../../common/api/entity_analytics/risk_score';
 
 export const createEsIndexRoute = (router: SecuritySolutionPluginRouter, logger: Logger) => {
   router.versioned

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/indices/delete_indices_route.ts b/x-pack/plugins/security_solution/server/lib/risk_score/indices/delete_indices_route.ts
@@ -10,7 +10,7 @@ import { buildSiemResponse } from '@kbn/lists-plugin/server/routes/utils';
 import { RISK_SCORE_DELETE_INDICES } from '../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../types';
 import { deleteEsIndices } from './lib/delete_indices';
-import { deleteIndicesRequestBody } from '../../../../common/api/risk_score';
+import { deleteIndicesRequestBody } from '../../../../common/api/entity_analytics/risk_score';
 
 export const deleteEsIndicesRoute = (router: SecuritySolutionPluginRouter) => {
   router.versioned

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/indices/lib/create_index.ts b/x-pack/plugins/security_solution/server/lib/risk_score/indices/lib/create_index.ts
@@ -6,7 +6,7 @@
  */
 import type { ElasticsearchClient, Logger } from '@kbn/core/server';
 import { transformError } from '@kbn/securitysolution-es-utils';
-import type { CreateEsIndexRequestBody } from '../../../../../common/api/risk_score';
+import type { CreateEsIndexRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 export const createIndex = async ({
   esClient,

diff --git a/.../plugins/security_solution/server/lib/risk_score/onboarding/routes/install_risk_scores.ts b/.../plugins/security_solution/server/lib/risk_score/onboarding/routes/install_risk_scores.ts
@@ -16,7 +16,7 @@ import type { SetupPlugins } from '../../../../plugin';
 import { buildSiemResponse } from '../../../detection_engine/routes/utils';
 
 import { installRiskScoreModule } from '../helpers/install_risk_score_module';
-import { onboardingRiskScoreRequestBody } from '../../../../../common/api/risk_score';
+import { onboardingRiskScoreRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 export const installRiskScoresRoute = (
   router: SecuritySolutionPluginRouter,

diff --git a/...r/lib/risk_score/prebuilt_dev_tool_content/routes/read_prebuilt_dev_tool_content_route.ts b/...r/lib/risk_score/prebuilt_dev_tool_content/routes/read_prebuilt_dev_tool_content_route.ts
@@ -14,7 +14,7 @@ import { DEV_TOOL_PREBUILT_CONTENT } from '../../../../../common/constants';
 
 import type { SecuritySolutionPluginRouter } from '../../../../types';
 import { consoleMappings } from '../console_mappings';
-import { readConsoleRequestBody } from '../../../../../common/api/risk_score';
+import { readConsoleRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 import { RiskScoreEntity } from '../../../../../common/search_strategy';
 import { getView } from '../utils';

diff --git a/.../plugins/security_solution/server/lib/risk_score/prebuilt_dev_tool_content/schema.test.ts b/.../plugins/security_solution/server/lib/risk_score/prebuilt_dev_tool_content/schema.test.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { readConsoleRequestBody } from '../../../../common/api/risk_score';
+import { readConsoleRequestBody } from '../../../../common/api/entity_analytics/risk_score';
 
 describe('ReadConsoleRequestSchema', () => {
   it('should throw error', () => {

diff --git a/...tion/server/lib/risk_score/prebuilt_saved_objects/routes/create_prebuilt_saved_objects.ts b/...tion/server/lib/risk_score/prebuilt_saved_objects/routes/create_prebuilt_saved_objects.ts
@@ -16,7 +16,7 @@ import { buildSiemResponse } from '../../../detection_engine/routes/utils';
 
 import { buildFrameworkRequest } from '../../../timeline/utils/common';
 import { bulkCreateSavedObjects } from '../helpers/bulk_create_saved_objects';
-import { createPrebuiltSavedObjectsRequestBody } from '../../../../../common/api/risk_score';
+import { createPrebuiltSavedObjectsRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 export const createPrebuiltSavedObjectsRoute = (
   router: SecuritySolutionPluginRouter,

diff --git a/...tion/server/lib/risk_score/prebuilt_saved_objects/routes/delete_prebuilt_saved_objects.ts b/...tion/server/lib/risk_score/prebuilt_saved_objects/routes/delete_prebuilt_saved_objects.ts
@@ -16,7 +16,7 @@ import { buildSiemResponse } from '../../../detection_engine/routes/utils';
 
 import { buildFrameworkRequest } from '../../../timeline/utils/common';
 import { bulkDeleteSavedObjects } from '../helpers/bulk_delete_saved_objects';
-import { deletePrebuiltSavedObjectsRequestBody } from '../../../../../common/api/risk_score';
+import { deletePrebuiltSavedObjectsRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 export const deletePrebuiltSavedObjectsRoute = (
   router: SecuritySolutionPluginRouter,

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/create_script_route.ts b/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/create_script_route.ts
@@ -8,7 +8,7 @@
 import type { Logger } from '@kbn/core/server';
 import { buildSiemResponse } from '@kbn/lists-plugin/server/routes/utils';
 import { transformError } from '@kbn/securitysolution-es-utils';
-import { createStoredScriptRequestBody } from '../../../../common/api/risk_score';
+import { createStoredScriptRequestBody } from '../../../../common/api/entity_analytics/risk_score';
 import { RISK_SCORE_CREATE_STORED_SCRIPT } from '../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../types';
 import { createStoredScript } from './lib/create_script';

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/delete_script_route.ts b/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/delete_script_route.ts
@@ -10,7 +10,7 @@ import { buildSiemResponse } from '@kbn/lists-plugin/server/routes/utils';
 import { RISK_SCORE_DELETE_STORED_SCRIPT } from '../../../../common/constants';
 import type { SecuritySolutionPluginRouter } from '../../../types';
 import { deleteStoredScript } from './lib/delete_script';
-import { deleteStoredScriptRequestBody } from '../../../../common/api/risk_score';
+import { deleteStoredScriptRequestBody } from '../../../../common/api/entity_analytics/risk_score';
 
 export const deleteStoredScriptRoute = (router: SecuritySolutionPluginRouter) => {
   router.versioned

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/lib/create_script.ts b/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/lib/create_script.ts
@@ -6,7 +6,7 @@
  */
 import type { ElasticsearchClient, Logger } from '@kbn/core/server';
 import { transformError } from '@kbn/securitysolution-es-utils';
-import type { CreateStoredScriptRequestBody } from '../../../../../common/api/risk_score';
+import type { CreateStoredScriptRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 export const createStoredScript = async ({
   esClient,

diff --git a/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/lib/delete_script.ts b/x-pack/plugins/security_solution/server/lib/risk_score/stored_scripts/lib/delete_script.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 import type { IScopedClusterClient } from '@kbn/core-elasticsearch-server';
-import type { DeleteStoredScriptRequestBody } from '../../../../../common/api/risk_score';
+import type { DeleteStoredScriptRequestBody } from '../../../../../common/api/entity_analytics/risk_score';
 
 export const deleteStoredScript = async ({
   client,