use @kbn/config-schema

x-pack/plugins/fleet/server/routes/schema/errors.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { schema } from '@kbn/config-schema';
+
+export const genericErrorResponse = () =>
+  schema.object(
+    {
+      statusCode: schema.number(),
+      error: schema.string(),
+      message: schema.string(),
+    },
+    {
+      meta: { description: 'Generic Error' },
+    }
+  );
+
+export const internalErrorResponse = () =>
+  schema.object(
+    {
+      message: schema.string(),
+    },
+    { meta: { description: 'Internal Server Error' } }
+  );

x-pack/plugins/fleet/server/routes/setup/index.ts

@@ -4,6 +4,7 @@
  * 2.0; you may not use this file except in compliance with the Elastic License
  * 2.0.
  */
+import { schema } from '@kbn/config-schema';
 
 import type { FleetAuthzRouter } from '../../services/security';
 
@@ -12,6 +13,8 @@ import { API_VERSIONS } from '../../../common/constants';
 
 import type { FleetConfigType } from '../../../common/types';
 
+import { genericErrorResponse, internalErrorResponse } from '../schema/errors';
+
 import { getFleetStatusHandler, fleetSetupHandler } from './handlers';
 
 export const registerFleetSetupRoute = (router: FleetAuthzRouter) => {
@@ -26,7 +29,38 @@ export const registerFleetSetupRoute = (router: FleetAuthzRouter) => {
     .addVersion(
       {
         version: API_VERSIONS.public.v1,
-        validate: false,
+        validate: {
+          // operationId: 'setup',
+          request: {},
+          response: {
+            200: {
+              body: () =>
+                schema.object(
+                  {
+                    isInitialized: schema.boolean(),
+                    nonFatalErrors: schema.arrayOf(
+                      schema.object({
+                        name: schema.string(),
+                        message: schema.string(),
+                      })
+                    ),
+                  },
+                  {
+                    meta: {
+                      description:
+                        "A summary of the result of Fleet's `setup` lifecycle. If `isInitialized` is true, Fleet is ready to accept agent enrollment. `nonFatalErrors` may include useful insight into non-blocking issues with Fleet setup.",
+                    },
+                  }
+                ),
+            },
+            400: {
+              body: genericErrorResponse,
+            },
+            500: {
+              body: internalErrorResponse,
+            },
+          },
+        },
       },
       fleetSetupHandler
     );