[Core] [UA] Support API Deprecations

packages/core/deprecations/core-deprecations-browser-internal/src/deprecations_client.ts

@@ -8,7 +8,7 @@
  */
 
 import { i18n } from '@kbn/i18n';
-import type { HttpStart } from '@kbn/core-http-browser';
+import type { HttpFetchOptionsWithPath, HttpStart } from '@kbn/core-http-browser';
 import type {
   DomainDeprecationDetails,
   DeprecationsGetResponse,
@@ -47,31 +47,70 @@ export class DeprecationsClient {
     return typeof details.correctiveActions.api === 'object';
   };
 
-  public resolveDeprecation = async (
+  private getResolveFetchDetails = (
     details: DomainDeprecationDetails
-  ): Promise<ResolveDeprecationResponse> => {
+  ): HttpFetchOptionsWithPath | undefined => {
     const { domainId, correctiveActions } = details;
-    // explicit check required for TS type guard
-    if (typeof correctiveActions.api !== 'object') {
-      return {
-        status: 'fail',
-        reason: i18n.translate('core.deprecations.noCorrectiveAction', {
-          defaultMessage: 'This deprecation cannot be resolved automatically.',
-        }),
-      };
-    }
 
-    const { body, method, path, omitContextFromBody = false } = correctiveActions.api;
-    try {
-      await this.http.fetch<void>({
+    if (correctiveActions.api) {
+      const { body, method, path, omitContextFromBody = false } = correctiveActions.api;
+
+      return {
         path,
         method,
         asSystemRequest: true,
         body: JSON.stringify({
           ...body,
           ...(omitContextFromBody ? {} : { deprecationDetails: { domainId } }),
         }),
-      });
+      };
+    }
+
+    if (correctiveActions.mark_as_resolved_api) {
+      const { routeMethod, routePath, routeVersion, apiTotalCalls, totalMarkedAsResolved } =
+        correctiveActions.mark_as_resolved_api;
+      const incrementBy = apiTotalCalls - totalMarkedAsResolved;
+
+      return {
+        path: '/api/deprecations/mark_as_resolved/',
+        method: 'POST',
+        asSystemRequest: true,
+        body: JSON.stringify({
+          domainId,
+          routeMethod,
+          routePath,
+          routeVersion,
+          incrementBy,
+        }),
+      };
+    }
+  };
+
+  public resolveDeprecation = async (
+    details: DomainDeprecationDetails
+  ): Promise<ResolveDeprecationResponse> => {
+    const { correctiveActions } = details;
+    const noCorrectiveActionFail = {
+      status: 'fail' as const,
+      reason: i18n.translate('core.deprecations.noCorrectiveAction', {
+        defaultMessage: 'This deprecation cannot be resolved automatically or marked as resolved.',
+      }),
+    };
+
+    if (
+      typeof correctiveActions.api !== 'object' &&
+      typeof correctiveActions.mark_as_resolved_api !== 'object'
+    ) {
+      return noCorrectiveActionFail;
+    }
+
+    try {
+      const fetchParams = this.getResolveFetchDetails(details);
+      if (!fetchParams) {
+        return noCorrectiveActionFail;
+      }
+
+      await this.http.fetch<void>(fetchParams);
       return { status: 'ok' };
     } catch (err) {
       return {

packages/core/deprecations/core-deprecations-common/src/types.ts

@@ -39,7 +39,7 @@ export interface BaseDeprecationDetails {
    * Predefined types are necessary to reduce having similar definitions with different keywords
    * across kibana deprecations.
    */
-  deprecationType?: 'config' | 'feature';
+  deprecationType?: 'config' | 'api' | 'feature';
   /** (optional) link to the documentation for more details on the deprecation. */
   documentationUrl?: string;
   /** (optional) specify the fix for this deprecation requires a full kibana restart. */
@@ -70,9 +70,31 @@ export interface BaseDeprecationDetails {
      * Check the README for writing deprecations in `src/core/server/deprecations/README.mdx`
      */
     manualSteps: string[];
+    /**
+     * (optional) The api to be called to mark the deprecation as resolved
+     * This corrective action when called should not resolve the deprecation
+     * instead it helps users track manually deprecated apis
+     * If the API used does resolve the deprecation use `correctiveActions.api`
+     */
+    mark_as_resolved_api?: {
+      apiTotalCalls: number;
+      totalMarkedAsResolved: number;
+      timestamp: Date | number | string;
+      routePath: string;
+      routeMethod: string;
+      routeVersion?: string;
+    };
   };
 }
 
+/**
+ * @public
+ */
+export interface ApiDeprecationDetails extends BaseDeprecationDetails {
+  apiId: string;
+  deprecationType: 'api';
+}
+
 /**
  * @public
  */
@@ -91,7 +113,10 @@ export interface FeatureDeprecationDetails extends BaseDeprecationDetails {
 /**
  * @public
  */
-export type DeprecationsDetails = ConfigDeprecationDetails | FeatureDeprecationDetails;
+export type DeprecationsDetails =
+  | ConfigDeprecationDetails
+  | ApiDeprecationDetails
+  | FeatureDeprecationDetails;
 
 /**
  * @public