Merge pull request #807 from BitGo/DX-494-comments-from-decls

feat: add support for comments from declarations

Author: bitgopatmcl

packages/openapi-generator/src/cli.ts

@@ -177,7 +177,7 @@ const app = command({
           );
           process.exit(1);
         }
-        const [newSourceFile, init] = initE.right;
+        const [newSourceFile, init, comment] = initE.right;
 
         const codecE = parseCodecInitializer(project.right, newSourceFile, init);
         if (E.isLeft(codecE)) {
@@ -186,6 +186,10 @@ const app = command({
           );
           process.exit(1);
         }
+        if (comment !== undefined) {
+          codecE.right.comment = comment;
+        }
+
         components[ref.name] = codecE.right;
         queue.push(codecE.right);
       }

packages/openapi-generator/test/openapi.test.ts

@@ -668,6 +668,91 @@ testCase('request body ref', SCHEMA_REF, {
   },
 });
 
+const SCHEMA_REF_WITH_COMMENT_AT_DECLARATION = `
+import * as t from 'io-ts';
+import * as h from '@api-ts/io-ts-http';
+
+export const route = h.httpRoute({
+  path: '/foo',
+  method: 'GET',
+  request: h.httpRequest({
+    params: {
+      body: t.string,
+      /**
+       * Size of the body
+       * @example 10
+       */
+      size: t.number,
+    }
+  }),
+  response: {
+    200: Foo
+  },
+});
+
+/**
+ * a Foo of type 'string'
+ * @example "foo"
+ */
+const Foo = t.string;
+`;
+
+testCase('request body ref with comments', SCHEMA_REF_WITH_COMMENT_AT_DECLARATION, {
+  openapi: "3.0.3",
+  info: {
+    title: "Test",
+    version: "1.0.0"
+  },
+  paths: {
+    "/foo": {
+      get: {
+        parameters: [
+          {
+            name: "body",
+            in: "path",
+            required: true,
+            schema: {
+              type: "string"
+            }
+          },
+          {
+            name: "size",
+            description: "Size of the body",
+            in: "path",
+            required: true,
+            schema: {
+              type: "number",
+              example: 10
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/Foo"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {
+      Foo: {
+        title: "Foo",
+        type: "string",
+        description: "a Foo of type 'string'",
+        example: "foo"
+      }
+    }
+  }
+});
+
 const SCHEMA_DOUBLE_REF = `
 import * as t from 'io-ts';
 import * as h from '@api-ts/io-ts-http';