add API response types

elastic · Feb 7, 2020 · 6d05c51 · 6d05c51
1 parent 227b694
commit 6d05c51
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 17 deletions.
diff --git a/x-pack/plugins/ingest_manager/common/types/rest_spec/epm.ts b/x-pack/plugins/ingest_manager/common/types/rest_spec/epm.ts
@@ -4,14 +4,45 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 import { schema } from '@kbn/config-schema';
-import { AssetReference } from '../epm';
+import {
+  AssetReference,
+  CategorySummaryList,
+  Installable,
+  RegistryPackage,
+  Installed,
+  NotInstalled,
+} from '../epm';
 
+export interface GetCategoriesResponse {
+  response: CategorySummaryList;
+  success: boolean;
+}
 export const GetPackagesRequestSchema = {
   query: schema.object({
     category: schema.maybe(schema.string()),
   }),
 };
 
+export interface GetPackagesResponse {
+  response: Array<
+    Installable<
+      Pick<
+        RegistryPackage,
+        | 'name'
+        | 'title'
+        | 'version'
+        | 'description'
+        | 'type'
+        | 'icons'
+        | 'internal'
+        | 'download'
+        | 'path'
+      >
+    >
+  >;
+  success: boolean;
+}
+
 export const GetFileRequestSchema = {
   params: schema.object({
     pkgkey: schema.string(),
@@ -25,6 +56,11 @@ export const GetInfoRequestSchema = {
   }),
 };
 
+export interface GetInfoResponse {
+  response: Installed | NotInstalled;
+  success: boolean;
+}
+
 export const InstallPackageRequestSchema = {
   params: schema.object({
     pkgkey: schema.string(),

diff --git a/x-pack/plugins/ingest_manager/server/routes/epm/handlers.ts b/x-pack/plugins/ingest_manager/server/routes/epm/handlers.ts
@@ -6,9 +6,12 @@
 import { TypeOf } from '@kbn/config-schema';
 import { RequestHandler, CustomHttpResponseOptions } from 'kibana/server';
 import {
+  GetCategoriesResponse,
   GetPackagesRequestSchema,
+  GetPackagesResponse,
   GetFileRequestSchema,
   GetInfoRequestSchema,
+  GetInfoResponse,
   InstallPackageRequestSchema,
   InstallPackageResponse,
   DeletePackageRequestSchema,
@@ -29,12 +32,11 @@ import { getClusterAccessor } from '../../services/epm/cluster_access';
 export const getCategoriesHandler: RequestHandler = async (context, request, response) => {
   try {
     const res = await getCategories();
-    return response.ok({
-      body: {
-        response: res,
-        success: true,
-      },
-    });
+    const body: GetCategoriesResponse = {
+      response: res,
+      success: true,
+    };
+    return response.ok({ body });
   } catch (e) {
     return response.customError({
       statusCode: 500,
@@ -53,11 +55,12 @@ export const getListHandler: RequestHandler<
       savedObjectsClient,
       category: request.query.category,
     });
+    const body: GetPackagesResponse = {
+      response: res,
+      success: true,
+    };
     return response.ok({
-      body: {
-        response: res,
-        success: true,
-      },
+      body,
     });
   } catch (e) {
     return response.customError({
@@ -105,12 +108,11 @@ export const getInfoHandler: RequestHandler<TypeOf<typeof GetInfoRequestSchema.p
     const { pkgkey } = request.params;
     const savedObjectsClient = context.core.savedObjects.client;
     const res = await getPackageInfo({ savedObjectsClient, pkgkey });
-    return response.ok({
-      body: {
-        response: res,
-        success: true,
-      },
-    });
+    const body: GetInfoResponse = {
+      response: res,
+      success: true,
+    };
+    return response.ok({ body });
   } catch (e) {
     return response.customError({
       statusCode: 500,