[Cases] Deprecate endpoints

x-pack/plugins/cases/server/client/client.ts

@@ -18,6 +18,7 @@ import { createMetricsSubClient, MetricsSubClient } from './metrics/client';
  * Client wrapper that contains accessor methods for individual entities within the cases system.
  */
 export class CasesClient {
+  private readonly _kibanaVersion: CasesClientArgs['kibanaVersion'];
   private readonly _casesClientInternal: CasesClientInternal;
   private readonly _cases: CasesSubClient;
   private readonly _attachments: AttachmentsSubClient;
@@ -27,6 +28,7 @@ export class CasesClient {
   private readonly _metrics: MetricsSubClient;
 
   constructor(args: CasesClientArgs) {
+    this._kibanaVersion = args.kibanaVersion;
     this._casesClientInternal = createCasesClientInternal(args);
     this._cases = createCasesSubClient(args, this, this._casesClientInternal);
     this._attachments = createAttachmentsSubClient(args, this, this._casesClientInternal);
@@ -36,6 +38,13 @@ export class CasesClient {
     this._metrics = createMetricsSubClient(args, this);
   }
 
+  /**
+   * Retrieves the current kibana version
+   */
+  public get kibanaVersion() {
+    return this._kibanaVersion;
+  }
+
   /**
    * Retrieves an interface for interacting with cases entities.
    */

x-pack/plugins/cases/server/client/factory.ts

@@ -10,6 +10,7 @@ import {
   SavedObjectsServiceStart,
   Logger,
   ElasticsearchClient,
+  PluginInitializerContext,
 } from 'kibana/server';
 import { SecurityPluginSetup, SecurityPluginStart } from '../../../security/server';
 import { SAVED_OBJECT_TYPES } from '../../common/constants';
@@ -31,6 +32,7 @@ import { AuthorizationAuditLogger } from '../authorization';
 import { CasesClient, createCasesClient } from '.';
 
 interface CasesClientFactoryArgs {
+  kibanaVersion: PluginInitializerContext['env']['packageInfo']['version'];
   securityPluginSetup?: SecurityPluginSetup;
   securityPluginStart?: SecurityPluginStart;
   getSpace: GetSpaceFn;
@@ -113,6 +115,7 @@ export class CasesClientFactory {
       lensEmbeddableFactory: this.options.lensEmbeddableFactory,
       authorization: auth,
       actionsClient: await this.options.actionsPluginStart.getActionsClientWithRequest(request),
+      kibanaVersion: this.options.kibanaVersion,
     });
   }
 }

x-pack/plugins/cases/server/client/types.ts

@@ -6,7 +6,7 @@
  */
 
 import type { PublicMethodsOf } from '@kbn/utility-types';
-import { SavedObjectsClientContract, Logger } from 'kibana/server';
+import { SavedObjectsClientContract, Logger, PluginInitializerContext } from 'kibana/server';
 import { User } from '../../common/api';
 import { Authorization } from '../authorization/authorization';
 import {
@@ -24,6 +24,7 @@ import { LensServerPluginSetup } from '../../../lens/server';
  * Parameters for initializing a cases client
  */
 export interface CasesClientArgs {
+  readonly kibanaVersion: PluginInitializerContext['env']['packageInfo']['version'];
   readonly caseConfigureService: CaseConfigureService;
   readonly caseService: CasesService;
   readonly connectorMappingsService: ConnectorMappingsService;

x-pack/plugins/cases/server/plugin.ts

@@ -59,11 +59,13 @@ export interface PluginStartContract {
 
 export class CasePlugin {
   private readonly log: Logger;
+  private readonly kibanaVersion: PluginInitializerContext['env']['packageInfo']['version'];
   private clientFactory: CasesClientFactory;
   private securityPluginSetup?: SecurityPluginSetup;
   private lensEmbeddableFactory?: LensServerPluginSetup['lensEmbeddableFactory'];
 
   constructor(private readonly initializerContext: PluginInitializerContext) {
+    this.kibanaVersion = initializerContext.env.packageInfo.version;
     this.log = this.initializerContext.logger.get();
     this.clientFactory = new CasesClientFactory(this.log);
   }
@@ -121,6 +123,7 @@ export class CasePlugin {
        */
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       lensEmbeddableFactory: this.lensEmbeddableFactory!,
+      kibanaVersion: this.kibanaVersion,
     });
 
     const client = core.elasticsearch.client;

x-pack/plugins/cases/server/routes/api/cases/get_case.ts

@@ -8,7 +8,7 @@
 import { schema } from '@kbn/config-schema';
 
 import { RouteDeps } from '../types';
-import { wrapError } from '../utils';
+import { getWarningHeader, wrapError } from '../utils';
 import { CASE_DETAILS_URL } from '../../../../common/constants';
 
 export function initGetCaseApi({ router, logger }: RouteDeps) {
@@ -20,6 +20,9 @@ export function initGetCaseApi({ router, logger }: RouteDeps) {
           case_id: schema.string(),
         }),
         query: schema.object({
+          /**
+           * @deprecated since version 8.1.0
+           */
           includeComments: schema.boolean({ defaultValue: true }),
         }),
       },
@@ -30,6 +33,12 @@ export function initGetCaseApi({ router, logger }: RouteDeps) {
         const id = request.params.case_id;
 
         return response.ok({
+          headers: {
+            ...getWarningHeader(
+              casesClient.kibanaVersion,
+              'Deprecated query parameter includeComments'
+            ),
+          },
           body: await casesClient.cases.get({
             id,
             includeComments: request.query.includeComments,

x-pack/plugins/cases/server/routes/api/comments/get_all_comment.ts

@@ -8,9 +8,12 @@
 import { schema } from '@kbn/config-schema';
 
 import { RouteDeps } from '../types';
-import { wrapError } from '../utils';
+import { wrapError, getWarningHeader } from '../utils';
 import { CASE_COMMENTS_URL } from '../../../../common/constants';
 
+/**
+ * @deprecated since version 8.1.0
+ */
 export function initGetAllCommentsApi({ router, logger }: RouteDeps) {
   router.get(
     {
@@ -26,6 +29,9 @@ export function initGetAllCommentsApi({ router, logger }: RouteDeps) {
         const client = await context.cases.getCasesClient();
 
         return response.ok({
+          headers: {
+            ...getWarningHeader(client.kibanaVersion),
+          },
           body: await client.attachments.getAll({
             caseID: request.params.case_id,
           }),

x-pack/plugins/cases/server/routes/api/user_actions/get_all_user_actions.ts

@@ -8,9 +8,12 @@
 import { schema } from '@kbn/config-schema';
 
 import { RouteDeps } from '../types';
-import { wrapError } from '../utils';
+import { getWarningHeader, wrapError } from '../utils';
 import { CASE_USER_ACTIONS_URL } from '../../../../common/constants';
 
+/**
+ * @deprecated since version 8.1.0
+ */
 export function initGetAllCaseUserActionsApi({ router, logger }: RouteDeps) {
   router.get(
     {
@@ -31,6 +34,9 @@ export function initGetAllCaseUserActionsApi({ router, logger }: RouteDeps) {
         const caseId = request.params.case_id;
 
         return response.ok({
+          headers: {
+            ...getWarningHeader(casesClient.kibanaVersion),
+          },
           body: await casesClient.userActions.getAll({ caseId }),
         });
       } catch (error) {

x-pack/plugins/cases/server/routes/api/utils.ts

@@ -6,7 +6,6 @@
  */
 
 import { Boom, boomify, isBoom } from '@hapi/boom';
-
 import { schema } from '@kbn/config-schema';
 import { CustomHttpResponseOptions, ResponseError } from 'kibana/server';
 import { CaseError, isCaseError, HTTPError, isHTTPError } from '../../common/error';
@@ -35,3 +34,10 @@ export function wrapError(
 }
 
 export const escapeHatch = schema.object({}, { unknowns: 'allow' });
+
+export const getWarningHeader = (
+  kibanaVersion: string,
+  msg: string | undefined = 'Deprecated endpoint'
+): { warning: string } => ({
+  warning: `299 Kibana-${kibanaVersion} "${msg}"`,
+});