[Fleet] Make API responses consistent

x-pack/plugins/fleet/common/openapi/bundled.json

@@ -495,7 +495,7 @@
                 "schema": {
                   "type": "object",
                   "properties": {
-                    "list": {
+                    "items": {
                       "type": "array",
                       "items": {
                         "$ref": "#/components/schemas/agent"
@@ -512,7 +512,7 @@
                     }
                   },
                   "required": [
-                    "list",
+                    "items",
                     "total",
                     "page",
                     "perPage"
@@ -1305,7 +1305,7 @@
                 "schema": {
                   "type": "object",
                   "properties": {
-                    "list": {
+                    "items": {
                       "type": "array",
                       "items": {
                         "$ref": "#/components/schemas/enrollment_api_key"
@@ -1322,7 +1322,7 @@
                     }
                   },
                   "required": [
-                    "list",
+                    "items",
                     "page",
                     "perPage",
                     "total"

x-pack/plugins/fleet/common/openapi/bundled.yaml

@@ -308,7 +308,7 @@ paths:
               schema:
                 type: object
                 properties:
-                  list:
+                  items:
                     type: array
                     items:
                       $ref: '#/components/schemas/agent'
@@ -319,7 +319,7 @@ paths:
                   perPage:
                     type: number
                 required:
-                  - list
+                  - items
                   - total
                   - page
                   - perPage
@@ -795,7 +795,7 @@ paths:
               schema:
                 type: object
                 properties:
-                  list:
+                  items:
                     type: array
                     items:
                       $ref: '#/components/schemas/enrollment_api_key'
@@ -806,7 +806,7 @@ paths:
                   total:
                     type: number
                 required:
-                  - list
+                  - items
                   - page
                   - perPage
                   - total

x-pack/plugins/fleet/common/openapi/paths/agents.yaml

@@ -9,7 +9,7 @@ get:
           schema:
             type: object
             properties:
-              list:
+              items:
                 type: array
                 items:
                   $ref: ../components/schemas/agent.yaml
@@ -20,7 +20,7 @@ get:
               perPage:
                 type: number
             required:
-              - list
+              - items
               - total
               - page
               - perPage

x-pack/plugins/fleet/common/openapi/paths/enrollment_api_keys.yaml

@@ -9,7 +9,7 @@ get:
           schema:
             type: object
             properties:
-              list:
+              items:
                 type: array
                 items:
                   $ref: ../components/schemas/enrollment_api_key.yaml
@@ -20,7 +20,7 @@ get:
               total:
                 type: number
             required:
-              - list
+              - items
               - page
               - perPage
               - total

x-pack/plugins/fleet/common/types/rest_spec/agent.ts

@@ -7,22 +7,17 @@
 
 import type { Agent, AgentAction, NewAgentAction } from '../models';
 
+import type { ListResult, ListWithKuery } from './common';
+
 export interface GetAgentsRequest {
-  query: {
-    page: number;
-    perPage: number;
-    kuery?: string;
+  query: ListWithKuery & {
     showInactive: boolean;
     showUpgradeable?: boolean;
   };
 }
 
-export interface GetAgentsResponse {
-  list: Agent[];
-  total: number;
+export interface GetAgentsResponse extends ListResult<Agent> {
   totalInactive: number;
-  page: number;
-  perPage: number;
 }
 
 export interface GetOneAgentRequest {

x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts

@@ -7,7 +7,7 @@
 
 import type { AgentPolicy, NewAgentPolicy, FullAgentPolicy } from '../models';
 
-import type { ListWithKuery } from './common';
+import type { ListResult, ListWithKuery } from './common';
 
 export interface GetAgentPoliciesRequest {
   query: ListWithKuery & {
@@ -17,12 +17,7 @@ export interface GetAgentPoliciesRequest {
 
 export type GetAgentPoliciesResponseItem = AgentPolicy & { agents?: number };
 
-export interface GetAgentPoliciesResponse {
-  items: GetAgentPoliciesResponseItem[];
-  total: number;
-  page: number;
-  perPage: number;
-}
+export type GetAgentPoliciesResponse = ListResult<GetAgentPoliciesResponseItem>;
 
 export interface GetOneAgentPolicyRequest {
   params: {

x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts

@@ -7,20 +7,13 @@
 
 import type { EnrollmentAPIKey } from '../models';
 
+import type { ListResult, ListWithKuery } from './common';
+
 export interface GetEnrollmentAPIKeysRequest {
-  query: {
-    page: number;
-    perPage: number;
-    kuery?: string;
-  };
+  query: ListWithKuery;
 }
 
-export interface GetEnrollmentAPIKeysResponse {
-  list: EnrollmentAPIKey[];
-  total: number;
-  page: number;
-  perPage: number;
-}
+export type GetEnrollmentAPIKeysResponse = ListResult<EnrollmentAPIKey>;
 
 export interface GetOneEnrollmentAPIKeyRequest {
   params: {

x-pack/plugins/fleet/common/types/rest_spec/output.ts

@@ -7,6 +7,8 @@
 
 import type { Output } from '../models';
 
+import type { ListResult } from './common';
+
 export interface GetOneOutputResponse {
   item: Output;
 }
@@ -53,9 +55,4 @@ export interface PutOutputResponse {
   item: Output;
 }
 
-export interface GetOutputsResponse {
-  items: Output[];
-  total: number;
-  page: number;
-  perPage: number;
-}
+export type GetOutputsResponse = ListResult<Output>;

x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts

@@ -13,20 +13,13 @@ import type {
   PackagePolicyPackage,
 } from '../models';
 
+import type { ListResult, ListWithKuery } from './common';
+
 export interface GetPackagePoliciesRequest {
-  query: {
-    page: number;
-    perPage: number;
-    kuery?: string;
-  };
+  query: ListWithKuery;
 }
 
-export interface GetPackagePoliciesResponse {
-  items: PackagePolicy[];
-  total: number;
-  page: number;
-  perPage: number;
-}
+export type GetPackagePoliciesResponse = ListResult<PackagePolicy>;
 
 export interface GetOnePackagePolicyRequest {
   params: {

x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/index.tsx

@@ -308,7 +308,7 @@ export const AgentListPage: React.FunctionComponent<{}> = () => {
           inactive: agentsRequest.data.totalInactive,
         });
 
-        setAgents(agentsRequest.data.list);
+        setAgents(agentsRequest.data.items);
         setTotalAgents(agentsRequest.data.total);
         setTotalInactiveAgents(agentsRequest.data.totalInactive);
       } catch (error) {

x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/fleet_server_upgrade_modal.tsx

@@ -63,7 +63,7 @@ export const FleetServerUpgradeModal: React.FunctionComponent<Props> = ({ onClos
           throw res.error;
         }
 
-        for (const agent of res.data?.list ?? []) {
+        for (const agent of res.data?.items ?? []) {
           if (!agent.policy_id || agentPoliciesAlreadyChecked[agent.policy_id]) {
             continue;
           }

x-pack/plugins/fleet/public/applications/fleet/sections/agents/enrollment_token_list_page/index.tsx

@@ -182,7 +182,7 @@ export const EnrollmentTokenListPage: React.FunctionComponent<{}> = () => {
 
   const total = enrollmentAPIKeysRequest?.data?.total ?? 0;
   const rowItems =
-    enrollmentAPIKeysRequest?.data?.list.filter((enrollmentKey) => {
+    enrollmentAPIKeysRequest?.data?.items.filter((enrollmentKey) => {
       if (!agentPolicies.length || !enrollmentKey.policy_id) return false;
       const agentPolicy = agentPoliciesById[enrollmentKey.policy_id];
       return !agentPolicy?.is_managed;

x-pack/plugins/fleet/public/components/agent_enrollment_flyout/advanced_agent_authentication_settings.tsx

@@ -103,7 +103,7 @@ export const AdvancedAgentAuthenticationSettings: FunctionComponent<Props> = ({
   onKeyChange,
 }) => {
   const { notifications } = useStartServices();
-  const [enrollmentAPIKeys, setEnrollmentAPIKeys] = useState<GetEnrollmentAPIKeysResponse['list']>(
+  const [enrollmentAPIKeys, setEnrollmentAPIKeys] = useState<GetEnrollmentAPIKeysResponse['items']>(
     []
   );
 
@@ -143,7 +143,7 @@ export const AdvancedAgentAuthenticationSettings: FunctionComponent<Props> = ({
             throw new Error('No data while fetching enrollment API keys');
           }
 
-          const enrollmentAPIKeysResponse = res.data.list.filter(
+          const enrollmentAPIKeysResponse = res.data.items.filter(
             (key) => key.policy_id === agentPolicyId && key.active === true
           );
 

x-pack/plugins/fleet/server/routes/agent/handlers.ts

@@ -122,7 +122,7 @@ export const getAgentsHandler: RequestHandler<
       : 0;
 
     const body: GetAgentsResponse = {
-      list: agents,
+      items: agents,
       total,
       totalInactive,
       page,

x-pack/plugins/fleet/server/routes/enrollment_api_key/handler.ts

@@ -36,7 +36,7 @@ export const getEnrollmentApiKeysHandler: RequestHandler<
       perPage: request.query.perPage,
       kuery: request.query.kuery,
     });
-    const body: GetEnrollmentAPIKeysResponse = { list: items, total, page, perPage };
+    const body: GetEnrollmentAPIKeysResponse = { items, total, page, perPage };
 
     return response.ok({ body });
   } catch (error) {

x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/mock_endpoint_result_list.ts

@@ -150,7 +150,7 @@ const endpointListApiPathHandlerMocks = ({
     [INGEST_API_FLEET_AGENTS]: (): GetAgentsResponse => {
       return {
         total: totalAgentsUsingEndpoint,
-        list: [],
+        items: [],
         totalInactive: 0,
         page: 1,
         perPage: 10,

x-pack/test/fleet_api_integration/apis/agent_policy/agent_policy_with_agents_setup.ts

@@ -23,7 +23,7 @@ export default function (providerContext: FtrProviderContext) {
   async function getEnrollmentKeyForPolicyId(policyId: string) {
     const listRes = await supertest.get(`/api/fleet/enrollment-api-keys`).expect(200);
 
-    const key = listRes.body.list.find(
+    const key = listRes.body.items.find(
       (item: { policy_id: string; id: string }) => item.policy_id === policyId
     );
 

x-pack/test/fleet_api_integration/apis/agents/list.ts

@@ -66,7 +66,7 @@ export default function ({ getService }: FtrProviderContext) {
         .expect(200);
 
       expect(apiResponse.total).to.eql(1);
-      const agent = apiResponse.list[0];
+      const agent = apiResponse.items[0];
       expect(agent.access_api_key_id).to.eql('api-key-2');
     });
   });

x-pack/test/fleet_api_integration/apis/epm/setup.ts

@@ -87,7 +87,7 @@ export default function (providerContext: FtrProviderContext) {
         .set('Authorization', `Bearer ${token.value}`)
         .set('kbn-xsrf', 'xxx')
         .expect(200);
-      const enrollmentApiKeyId = response.body.list[0].id;
+      const enrollmentApiKeyId = response.body.items[0].id;
       await supertestWithoutAuth
         .get(`/api/fleet/enrollment-api-keys/${enrollmentApiKeyId}`)
         .set('Authorization', `Bearer ${token.value}`)

x-pack/test/fleet_cypress/agent.ts

@@ -53,7 +53,7 @@ export class AgentManager extends Manager {
       this.params.kibanaUrl + '/api/fleet/enrollment-api-keys',
       this.requestOptions
     );
-    const policy = apiKeys.list[1];
+    const policy = apiKeys.items[1];
 
     this.log.info('Running the agent');
 
@@ -87,7 +87,7 @@ export class AgentManager extends Manager {
         `${this.params.kibanaUrl}/api/fleet/agents`,
         this.requestOptions
       );
-      done = agents.list[0]?.status === 'online';
+      done = agents.items[0]?.status === 'online';
       if (++retries > 12) {
         this.log.error('Giving up on enrolling the agent after a minute');
         throw new Error('Agent timed out while coming online');

x-pack/test/osquery_cypress/agent.ts

@@ -69,7 +69,7 @@ export class AgentManager extends Manager {
       this.params.kibanaUrl + '/api/fleet/enrollment-api-keys',
       this.requestOptions
     );
-    const policy = apiKeys.list[1];
+    const policy = apiKeys.items[1];
 
     this.log.info('Enrolling the agent');
     const args = [
@@ -100,7 +100,7 @@ export class AgentManager extends Manager {
         `${this.params.kibanaUrl}/api/fleet/agents`,
         this.requestOptions
       );
-      done = agents.list[0]?.status === 'online';
+      done = agents.items[0]?.status === 'online';
       if (++retries > 12) {
         this.log.error('Giving up on enrolling the agent after a minute');
         throw new Error('Agent timed out while coming online');