fix(openapi): set response description correctly (#559)

Author: Gabrola

.changeset/rare-cheetahs-approve.md

@@ -0,0 +1,5 @@
+---
+'@ts-rest/open-api': patch
+---
+
+Fix setting of response description

libs/ts-rest/open-api/src/lib/ts-rest-open-api.spec.ts

@@ -55,13 +55,15 @@ const postsRouter = c.router({
       method: 'GET',
       path: '/posts/:id/comments',
       responses: {
-        200: z.object({
-          booleanString: z.boolean().transform((v) => v.toString()),
-          comments: z.union([
-            z.array(commentSchema),
-            z.array(commentSchema.extend({ author: z.string() })),
-          ]),
-        }),
+        200: z
+          .object({
+            booleanString: z.boolean().transform((v) => v.toString()),
+            comments: z.union([
+              z.array(commentSchema),
+              z.array(commentSchema.extend({ author: z.string() })),
+            ]),
+          })
+          .describe('Post comments'),
       },
     },
   }),
@@ -343,6 +345,7 @@ const expectedApiDoc = {
             content: {
               'application/json': {
                 schema: {
+                  description: 'Post comments',
                   properties: {
                     comments: {
                       oneOf: [
@@ -390,7 +393,7 @@ const expectedApiDoc = {
                 },
               },
             },
-            description: '200',
+            description: 'Post comments',
           },
         },
         summary: undefined,

libs/ts-rest/open-api/src/lib/ts-rest-open-api.ts

@@ -233,30 +233,32 @@ export const generateOpenApi = (
         ? getOpenApiSchemaFromZod(path.route.body)
         : null;
 
-    const responses = Object.keys(path.route.responses).reduce((acc, key) => {
-      const keyAsNumber = Number(key);
-
-      const responseSchema = getOpenApiSchemaFromZod(
-        path.route.responses[keyAsNumber],
-        true,
-      );
-
-      return {
-        ...acc,
-        [keyAsNumber]: {
-          description: `${keyAsNumber}`,
-          ...(responseSchema
-            ? {
-                content: {
-                  'application/json': {
-                    ...convertSchemaObjectToMediaTypeObject(responseSchema),
+    const responses = Object.entries(path.route.responses).reduce(
+      (acc, [statusCode, response]) => {
+        const responseSchema = getOpenApiSchemaFromZod(response, true);
+        const description =
+          isZodType(response) && response.description
+            ? response.description
+            : statusCode;
+
+        return {
+          ...acc,
+          [statusCode]: {
+            description,
+            ...(responseSchema
+              ? {
+                  content: {
+                    'application/json': {
+                      ...convertSchemaObjectToMediaTypeObject(responseSchema),
+                    },
                   },
-                },
-              }
-            : {}),
-        },
-      };
-    }, {});
+                }
+              : {}),
+          },
+        };
+      },
+      {},
+    );
 
     const contentType =
       path.route?.method !== 'GET'