fix(oas): exclude description prop if undefined (#243)

src/oas/__tests__/externalDocs.test.ts

@@ -0,0 +1,53 @@
+import { toExternalDocs } from '../externalDocs';
+
+describe('toExternalDocs', () => {
+  it.each([null, undefined, ['array'], 'string', 1])(
+    'returns empty object if supplied externalDocs is "%s"',
+    externalDocs => {
+      const actual = toExternalDocs(externalDocs);
+
+      expect(actual).toEqual({});
+    },
+  );
+
+  it.each([null, undefined, 1, ['array'], { object: 'type' }, '', '         '])(
+    'returns emtpy object if url is "%s"',
+    url => {
+      const externalDocs = {
+        url,
+        description: 'some description',
+      };
+
+      const actual = toExternalDocs(externalDocs);
+      expect(actual).toEqual({});
+    },
+  );
+
+  it.each([null, undefined, 1, ['array'], { object: 'type' }, '', '      '])(
+    'excludes description if it is "%s"',
+    description => {
+      const externalDocs = {
+        url: 'http://some.url',
+        description,
+      };
+
+      const actual = toExternalDocs(externalDocs);
+      expect(actual).toEqual({ externalDocs: { url: 'http://some.url' } });
+    },
+  );
+
+  it('includes both url and description if they are valid', () => {
+    const externalDocs = {
+      url: 'http://some.url',
+      description: 'some description',
+    };
+
+    const actual = toExternalDocs(externalDocs);
+    expect(actual).toEqual({
+      externalDocs: {
+        url: 'http://some.url',
+        description: 'some description',
+      },
+    });
+  });
+});

src/oas/externalDocs.ts

@@ -15,10 +15,13 @@ export function toExternalDocs(externalDocs: any): { externalDocs?: IExternalDoc
     return {};
   }
 
+  const description = getDescription(externalDocs);
+  const descriptionProp = description ? { description } : {};
+
   return {
     externalDocs: {
       url,
-      description: getDescription(externalDocs),
+      ...descriptionProp,
     },
   };
 }