From 7bfccf74503c2f5cb231907d28fc0d31c11ce02e Mon Sep 17 00:00:00 2001
From: Jonathan Buttner <jonathan.buttner@elastic.co>
Date: Wed, 23 Sep 2020 14:54:27 -0400
Subject: [PATCH] Adding deprecated comments

---
 .../plugins/security_solution/common/endpoint/types/index.ts  | 1 +
 .../security_solution/server/endpoint/routes/resolver.ts      | 1 +
 .../endpoint/routes/resolver/queries/related_events.test.ts   | 3 +++
 .../server/endpoint/routes/resolver/queries/related_events.ts | 3 +++
 .../server/endpoint/routes/resolver/related_events.ts         | 3 +++
 .../endpoint/routes/resolver/utils/events_query_handler.ts    | 4 +++-
 6 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/x-pack/plugins/security_solution/common/endpoint/types/index.ts b/x-pack/plugins/security_solution/common/endpoint/types/index.ts
index 852e07ba6268d4..abb0ccee8d9097 100644
--- a/x-pack/plugins/security_solution/common/endpoint/types/index.ts
+++ b/x-pack/plugins/security_solution/common/endpoint/types/index.ts
@@ -278,6 +278,7 @@ export interface SafeResolverRelatedEvents {
 
 /**
  * Response structure for the events route.
+ * `nextEvent` will be set to null when at the time of querying there were no more results to retrieve from ES.
  */
 export interface ResolverPaginatedEvents {
   events: SafeResolverEvent[];
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/resolver.ts b/x-pack/plugins/security_solution/server/endpoint/routes/resolver.ts
index 4fb16918a8a562..c9159032a7917b 100644
--- a/x-pack/plugins/security_solution/server/endpoint/routes/resolver.ts
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/resolver.ts
@@ -29,6 +29,7 @@ export function registerResolverRoutes(router: IRouter, endpointAppContext: Endp
   // this route will be removed in favor of the one below
   router.post(
     {
+      // @deprecated use `/resolver/events` instead
       path: '/api/endpoint/resolver/{id}/events',
       validate: validateRelatedEvents,
       options: { authRequired: true },
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.test.ts b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.test.ts
index 253d7f9ff2bde9..3ddf8fa4090d6e 100644
--- a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.test.ts
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.test.ts
@@ -3,6 +3,9 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
+/**
+ * @deprecated use the `events.ts` file's query instead
+ */
 import { EventsQuery } from './related_events';
 import { PaginationBuilder } from '../utils/pagination';
 import { legacyEventIndexPattern } from './legacy_event_index_pattern';
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.ts b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.ts
index bd054d548a93aa..f419c1fb6e1d5b 100644
--- a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.ts
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/queries/related_events.ts
@@ -3,6 +3,9 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
+/**
+ * @deprecated use the `events.ts` file's query instead
+ */
 import { SearchResponse } from 'elasticsearch';
 import { esKuery } from '../../../../../../../../src/plugins/data/server';
 import { SafeResolverEvent } from '../../../../../common/endpoint/types';
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/related_events.ts b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/related_events.ts
index 85c2672f9be92d..8fd9ab9a5ccd32 100644
--- a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/related_events.ts
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/related_events.ts
@@ -4,6 +4,9 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+/**
+ * @deprecated use the `resolver/events` route and handler instead
+ */
 import { TypeOf } from '@kbn/config-schema';
 import { RequestHandler, Logger } from 'kibana/server';
 import { eventsIndexPattern, alertsIndexPattern } from '../../../../common/endpoint/constants';
diff --git a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/utils/events_query_handler.ts b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/utils/events_query_handler.ts
index 689632af96252e..a5aa9b6c288c82 100644
--- a/x-pack/plugins/security_solution/server/endpoint/routes/resolver/utils/events_query_handler.ts
+++ b/x-pack/plugins/security_solution/server/endpoint/routes/resolver/utils/events_query_handler.ts
@@ -3,7 +3,9 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-
+/**
+ * @deprecated msearch functionality for querying events will be removed shortly
+ */
 import { SearchResponse } from 'elasticsearch';
 import { ILegacyScopedClusterClient } from 'kibana/server';
 import { SafeResolverRelatedEvents, SafeResolverEvent } from '../../../../../common/endpoint/types';