[EDR Workflows] Deprecate public endpoint/suggestions api endpoint in…

… favour of an internal one (#194832) New internal GET `/internal/api/endpoint/suggestions/{suggestion_type}` route. Current public GET `/api/endpoint/suggestions/{suggestion_type}` route is set to deprecated. UI uses now the internal GET `/internal/api/endpoint/suggestions/{suggestion_type}` api route --------- Co-authored-by: kibanamachine <[email protected]>
elastic · Oct 8, 2024 · ef4755a · ef4755a
1 parent ca1d375
commit ef4755a
Show file tree

Hide file tree

Showing 13 changed files with 91 additions and 9 deletions.
diff --git a/oas_docs/output/kibana.serverless.staging.yaml b/oas_docs/output/kibana.serverless.staging.yaml
@@ -8096,6 +8096,7 @@ paths:
  - Security Endpoint Management API
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  operationId: GetEndpointSuggestions
  parameters:
  - in: path

diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -8096,6 +8096,7 @@ paths:
  - Security Endpoint Management API
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  operationId: GetEndpointSuggestions
  parameters:
  - in: path

diff --git a/oas_docs/output/kibana.staging.yaml b/oas_docs/output/kibana.staging.yaml
@@ -11468,6 +11468,7 @@ paths:
  - Security Endpoint Management API
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  operationId: GetEndpointSuggestions
  parameters:
  - in: path

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -11468,6 +11468,7 @@ paths:
  - Security Endpoint Management API
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  operationId: GetEndpointSuggestions
  parameters:
  - in: path

diff --git a/x-pack/plugins/security_solution/common/api/endpoint/suggestions/get_suggestions.schema.yaml b/x-pack/plugins/security_solution/common/api/endpoint/suggestions/get_suggestions.schema.yaml
@@ -5,6 +5,7 @@ info:
 paths:
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  summary: Get suggestions
  operationId: GetEndpointSuggestions
  x-codegen-enabled: true

diff --git a/x-pack/plugins/security_solution/common/endpoint/constants.ts b/x-pack/plugins/security_solution/common/endpoint/constants.ts
@@ -60,6 +60,7 @@ export const FILE_STORAGE_DATA_INDEX = getFileDataIndexName('endpoint');
 
 // Location from where all Endpoint related APIs are mounted
 export const BASE_ENDPOINT_ROUTE = '/api/endpoint';
+export const BASE_INTERNAL_ENDPOINT_ROUTE = `/internal${BASE_ENDPOINT_ROUTE}`;
 
 // Endpoint API routes
 export const HOST_METADATA_LIST_ROUTE = `${BASE_ENDPOINT_ROUTE}/metadata`;
@@ -72,7 +73,9 @@ export const AGENT_POLICY_SUMMARY_ROUTE = `${BASE_POLICY_ROUTE}/summaries`;
 export const PROTECTION_UPDATES_NOTE_ROUTE = `${BASE_ENDPOINT_ROUTE}/protection_updates_note/{package_policy_id}`;
 
 /** Suggestions routes */
+/** @deprecated public route, use {@link SUGGESTIONS_INTERNAL_ROUTE} internal route */
 export const SUGGESTIONS_ROUTE = `${BASE_ENDPOINT_ROUTE}/suggestions/{suggestion_type}`;
+export const SUGGESTIONS_INTERNAL_ROUTE = `${BASE_INTERNAL_ENDPOINT_ROUTE}/suggestions/{suggestion_type}`;
 
 /**
  * Action Response Routes

diff --git a/...docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml b/...docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml
@@ -545,6 +545,7 @@ paths:
  - Security Endpoint Management API
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  operationId: GetEndpointSuggestions
  parameters:
  - in: path

diff --git a/...enapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml b/...enapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml
@@ -495,6 +495,7 @@ paths:
  - Security Endpoint Management API
  /api/endpoint/suggestions/{suggestion_type}:
  post:
+ deprecated: true
  operationId: GetEndpointSuggestions
  parameters:
  - in: path

diff --git a/...lugins/security_solution/public/management/pages/event_filters/service/api_client.test.ts b/...lugins/security_solution/public/management/pages/event_filters/service/api_client.test.ts
@@ -0,0 +1,44 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { HttpSetup } from '@kbn/core-http-browser';
+import { EventFiltersApiClient } from './api_client';
+import { coreMock } from '@kbn/core/public/mocks';
+import { SUGGESTIONS_INTERNAL_ROUTE } from '../../../../../common/endpoint/constants';
+import { resolvePathVariables } from '../../../../common/utils/resolve_path_variables';
+
+describe('EventFiltersApiClient', () => {
+ let fakeHttpServices: jest.Mocked<HttpSetup>;
+ let eventFiltersApiClient: EventFiltersApiClient;
+
+ beforeAll(() => {
+ fakeHttpServices = coreMock.createStart().http as jest.Mocked<HttpSetup>;
+ eventFiltersApiClient = new EventFiltersApiClient(fakeHttpServices);
+ });
+
+ beforeEach(() => {
+ jest.clearAllMocks();
+ });
+
+ it('should call the SUGGESTIONS_INTERNAL_ROUTE with correct URL and body', async () => {
+ await eventFiltersApiClient.getSuggestions({
+ field: 'host.name',
+ query: 'test',
+ });
+
+ expect(fakeHttpServices.post).toHaveBeenCalledWith(
+ resolvePathVariables(SUGGESTIONS_INTERNAL_ROUTE, { suggestion_type: 'eventFilters' }),
+ {
+ version: '1',
+ body: JSON.stringify({
+ field: 'host.name',
+ query: 'test',
+ }),
+ }
+ );
+ });
+});
diff --git a/x-pack/plugins/security_solution/public/management/pages/event_filters/service/api_client.ts b/x-pack/plugins/security_solution/public/management/pages/event_filters/service/api_client.ts
@@ -12,8 +12,8 @@ import type {
  UpdateExceptionListItemSchema,
 } from '@kbn/securitysolution-io-ts-list-types';
 import { removeIdFromExceptionItemsEntries } from '@kbn/securitysolution-list-hooks';
+import { SUGGESTIONS_INTERNAL_ROUTE } from '../../../../../common/endpoint/constants';
 import type { EndpointSuggestionsBody } from '../../../../../common/api/endpoint';
-import { SUGGESTIONS_ROUTE } from '../../../../../common/endpoint/constants';
 import { resolvePathVariables } from '../../../../common/utils/resolve_path_variables';
 import { ExceptionsListApiClient } from '../../../services/exceptions_list/exceptions_list_api_client';
 import { EVENT_FILTER_LIST_DEFINITION } from '../constants';
@@ -55,9 +55,9 @@ export class EventFiltersApiClient extends ExceptionsListApiClient {
  */
  async getSuggestions(body: EndpointSuggestionsBody): Promise<string[]> {
  const result: string[] = await this.getHttp().post(
- resolvePathVariables(SUGGESTIONS_ROUTE, { suggestion_type: 'eventFilters' }),
+ resolvePathVariables(SUGGESTIONS_INTERNAL_ROUTE, { suggestion_type: 'eventFilters' }),
  {
- version: this.version,
+ version: '1',
  body: JSON.stringify(body),
  }
  );

diff --git a/...ty_solution/public/management/services/exceptions_list/exceptions_list_api_client.test.ts b/...ty_solution/public/management/services/exceptions_list/exceptions_list_api_client.test.ts
@@ -59,9 +59,9 @@ describe('Exceptions List Api Client', () => {
  );
  });
 
- describe('Wen getting an instance', () => {
+ describe('When getting an instance', () => {
  /**
- * ATENTION: Skipping or modifying this test may cause the other test fails because it's creating the initial Singleton instance.
+ * ATTENTION: Skipping or modifying this test may cause the other test fails because it's creating the initial Singleton instance.
  * If you want to run tests individually, add this one to the execution with the .only method
  */
  it('New instance is created the first time and the create list method is called', () => {

diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.test.ts
@@ -39,7 +39,10 @@ import {
 } from '.';
 import { EndpointActionGenerator } from '../../../../common/endpoint/data_generators/endpoint_action_generator';
 import { getEndpointAuthzInitialStateMock } from '../../../../common/endpoint/service/authz/mocks';
-import { eventsIndexPattern, SUGGESTIONS_ROUTE } from '../../../../common/endpoint/constants';
+import {
+ eventsIndexPattern,
+ SUGGESTIONS_INTERNAL_ROUTE,
+} from '../../../../common/endpoint/constants';
 import { EndpointAppContextService } from '../../endpoint_app_context_services';
 
 jest.mock('@kbn/unified-search-plugin/server/autocomplete/terms_enum', () => {
@@ -184,15 +187,15 @@ describe('when calling the Suggestions route handler', () => {
  routerMock,
  'post',
  routePrefix,
- '2023-10-31'
+ '1'
  );
 
  await routeHandler(ctx as unknown as RequestHandlerContext, mockRequest, mockResponse);
  };
  });
 
  it('should respond with forbidden', async () => {
- await callRoute(SUGGESTIONS_ROUTE, {
+ await callRoute(SUGGESTIONS_INTERNAL_ROUTE, {
  params: { suggestion_type: 'eventFilters' },
  authz: { canReadEventFilters: true, canWriteEventFilters: false },
  });

diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.ts b/x-pack/plugins/security_solution/server/endpoint/routes/suggestions/index.ts
@@ -21,7 +21,11 @@ import type {
  SecuritySolutionRequestHandlerContext,
 } from '../../../types';
 import type { EndpointAppContext } from '../../types';
-import { eventsIndexPattern, SUGGESTIONS_ROUTE } from '../../../../common/endpoint/constants';
+import {
+ eventsIndexPattern,
+ SUGGESTIONS_INTERNAL_ROUTE,
+ SUGGESTIONS_ROUTE,
+} from '../../../../common/endpoint/constants';
 import { withEndpointAuthz } from '../with_endpoint_authz';
 import { errorHandler } from '../error_handler';
 
@@ -39,6 +43,7 @@ export function registerEndpointSuggestionsRoutes(
  access: 'public',
  path: SUGGESTIONS_ROUTE,
  options: { authRequired: true, tags: ['access:securitySolution'] },
+ deprecated: true,
  })
  .addVersion(
  {
@@ -53,6 +58,26 @@ export function registerEndpointSuggestionsRoutes(
  getEndpointSuggestionsRequestHandler(config$, getLogger(endpointContext))
  )
  );
+
+ router.versioned
+ .post({
+ access: 'internal',
+ path: SUGGESTIONS_INTERNAL_ROUTE,
+ options: { authRequired: true, tags: ['access:securitySolution'] },
+ })
+ .addVersion(
+ {
+ version: '1',
+ validate: {
+ request: EndpointSuggestionsSchema,
+ },
+ },
+ withEndpointAuthz(
+ { any: ['canWriteEventFilters'] },
+ endpointContext.logFactory.get('endpointSuggestions'),
+ getEndpointSuggestionsRequestHandler(config$, getLogger(endpointContext))
+ )
+ );
 }
 
 export const getEndpointSuggestionsRequestHandler = (