Use text/plain for non-object responses

akheron · Jan 10, 2021 · 2a8e3f7 · 2a8e3f7
1 parent c1bf138
commit 2a8e3f7
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 18 deletions.
diff --git a/src/generate.ts b/src/generate.ts
@@ -9,6 +9,9 @@ import {
   isPackageSymbol,
   getPropertyType,
   isNullType,
+  isStringType,
+  isNumberType,
+  isBooleanType,
   isBooleanLiteralType,
   isNumberLiteralType,
   isStringLiteralType,
@@ -338,12 +341,14 @@ const getResponseDefinition = (
       description: status, // TODO: What should the response description be?
       ...(bodySchema
         ? {
-            content: {
-              // TODO: application/json should probably not be hard-coded
-              'application/json': {
-                schema: bodySchema,
-              },
-            },
+            content:
+              isStringType(bodyType) || isNumberType(bodyType)
+                ? { 'text/plain': { schema: bodySchema } }
+                : {
+                    'application/json': {
+                      schema: bodySchema,
+                    },
+                  },
           }
         : undefined),
       ...(headers
@@ -467,13 +472,13 @@ const typeToSchema = (
     }
   }
 
-  if (type.flags & ts.TypeFlags.String) {
+  if (isStringType(type)) {
     return { type: 'string', ...nullable }
   }
-  if (type.flags & ts.TypeFlags.Number) {
+  if (isNumberType(type)) {
     return { type: 'number', ...nullable }
   }
-  if (type.flags & ts.TypeFlags.Boolean) {
+  if (isBooleanType(type)) {
     return { type: 'boolean', ...nullable }
   }
   if (isStringLiteralType(type)) {

diff --git a/src/utils.ts b/src/utils.ts
@@ -7,6 +7,12 @@ export const isOptional = (symbol: ts.Symbol): boolean =>
   !!(symbol.flags & ts.SymbolFlags.Optional)
 export const isObjectType = (type: ts.Type): boolean =>
   !!(type.flags & ts.TypeFlags.Object)
+export const isStringType = (type: ts.Type): boolean =>
+  !!(type.flags & ts.TypeFlags.String)
+export const isNumberType = (type: ts.Type): boolean =>
+  !!(type.flags & ts.TypeFlags.Number)
+export const isBooleanType = (type: ts.Type): boolean =>
+  !!(type.flags & ts.TypeFlags.Boolean)
 export const isBooleanLiteralType = (type: ts.Type): boolean =>
   !!(type.flags & ts.TypeFlags.BooleanLiteral)
 export const isNumberLiteralType = (

diff --git a/tests/__snapshots__/generate.spec.ts.snap b/tests/__snapshots__/generate.spec.ts.snap
@@ -55,7 +55,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -72,7 +72,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -119,7 +119,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -147,7 +147,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -157,7 +157,7 @@ Array [
             },
             "400": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -246,7 +246,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -259,7 +259,7 @@ Array [
             },
             "400": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -276,7 +276,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },
@@ -301,7 +301,7 @@ Array [
           "responses": Object {
             "200": Object {
               "content": Object {
-                "application/json": Object {
+                "text/plain": Object {
                   "schema": Object {
                     "type": "string",
                   },