[Fleet] Revert enrollment api key list removal

elastic · Nov 13, 2024 · c7ce232 · c7ce232
1 parent 0cc2e56
commit c7ce232
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts b/x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts
@@ -13,7 +13,10 @@ export interface GetEnrollmentAPIKeysRequest {
   query: ListWithKuery;
 }
 
-export type GetEnrollmentAPIKeysResponse = ListResult<EnrollmentAPIKey>;
+export type GetEnrollmentAPIKeysResponse = ListResult<EnrollmentAPIKey> & {
+  // deprecated in 8.x
+  list?: EnrollmentAPIKey[];
+};
 
 export interface GetOneEnrollmentAPIKeyRequest {
   params: {

diff --git a/x-pack/plugins/fleet/server/routes/enrollment_api_key/handler.ts b/x-pack/plugins/fleet/server/routes/enrollment_api_key/handler.ts
@@ -43,6 +43,7 @@ export const getEnrollmentApiKeysHandler: RequestHandler<
       spaceId: useSpaceAwareness ? getCurrentNamespace(soClient) : undefined,
     });
     const body: GetEnrollmentAPIKeysResponse = {
+      list: items, // deprecated
       items,
       total,
       page,

diff --git a/x-pack/plugins/fleet/server/routes/enrollment_api_key/index.ts b/x-pack/plugins/fleet/server/routes/enrollment_api_key/index.ts
@@ -111,7 +111,10 @@ export const registerRoutes = (router: FleetAuthzRouter) => {
           request: GetEnrollmentAPIKeysRequestSchema,
           response: {
             200: {
-              body: () => ListResponseSchema(EnrollmentAPIKeySchema),
+              body: () =>
+                ListResponseSchema(EnrollmentAPIKeySchema).extends({
+                  list: schema.arrayOf(EnrollmentAPIKeySchema, { meta: { deprecated: true } }),
+                }),
             },
             400: {
               body: genericErrorResponse,

diff --git a/x-pack/test/fleet_api_integration/apis/enrollment_api_keys/crud.ts b/x-pack/test/fleet_api_integration/apis/enrollment_api_keys/crud.ts
@@ -43,6 +43,8 @@ export default function (providerContext: FtrProviderContext) {
 
         expect(apiResponse.total).to.be(2);
         expect(apiResponse.items[0]).to.have.keys('id', 'api_key_id', 'name');
+        // Deprecated property list
+        expect(apiResponse.list[0]).to.have.keys('id', 'api_key_id', 'name');
         expect(apiResponse).to.have.keys('items');
       });
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,6 +43,7 @@ export const getEnrollmentApiKeysHandler: RequestHandler< @@
           spaceId: useSpaceAwareness ? getCurrentNamespace(soClient) : undefined,
         });
         const body: GetEnrollmentAPIKeysResponse = {
+          list: items, // deprecated
           items,
           total,
           page,
@@ Expand Down @@