Add support for components.responses (#429)

Author: drwpow

package-lock.json

@@ -63,7 +63,7 @@
     "js-yaml": "^3.14.0",
     "kleur": "^4.1.3",
     "meow": "^9.0.0",
-    "prettier": "^2.2.0"
+    "prettier": "^2.2.1"
   },
   "devDependencies": {
     "@pika/pack": "^0.5.0",
@@ -81,6 +81,6 @@
     "eslint-plugin-prettier": "^3.1.4",
     "jest": "^26.5.3",
     "ts-jest": "^26.4.1",
-    "typescript": "^4.1.2"
+    "typescript": "^4.1.3"
   }
 }

package.json

@@ -50,22 +50,21 @@ export interface OpenAPI3Parameter {
 }
 
 export interface OpenAPI3ResponseObject {
+  $ref?: string; // this is technically a lie; this should be a discriminated union type apart from OpenAPI3ResponseObject. However, in that scenario TS causes more trouble than it’s worth, so it’s here for convenience
   description?: string;
-  content?: {
-    [contentType: string]: { schema: OpenAPI3SchemaObject | OpenAPI3Reference };
-  };
+  content?: { [contentType: string]: { schema: OpenAPI3SchemaObject } };
 }
 
 export interface OpenAPI3RequestBody {
   description?: string;
   content?: {
-    [contentType: string]: { schema: OpenAPI3SchemaObject | { $ref: string } };
+    [contentType: string]: { schema: OpenAPI3SchemaObject };
   };
 }
 
 export interface OpenAPI3Components {
   schemas: OpenAPI3Schemas;
-  responses?: { [key: string]: OpenAPI3ResponseObject };
+  responses?: { [statusCode: string]: OpenAPI3ResponseObject };
   parameters?: { [key: string]: OpenAPI3Parameter };
 }
 

src/types/OpenAPI3.ts

@@ -127,7 +127,7 @@ export default function generateTypesV3(input: OpenAPI3 | OpenAPI3Schemas, optio
       }
 
       // 4. transform
-      output += transform(value.schema ? value.schema : value);
+      output += transform(value.schema || value);
 
       // 5. close nullable
       if (value.nullable) {
@@ -205,7 +205,15 @@ export default function generateTypesV3(input: OpenAPI3 | OpenAPI3Schemas, optio
     Object.entries(operation.responses).forEach(([statusCodeString, response]) => {
       // NOTE: Numeric status codes and the "default" response.
       const statusCode = Number(statusCodeString) || statusCodeString;
-      if (!response) return;
+      if (!response || typeof response !== "object") return;
+
+      // option 1: $ref
+      if (response.$ref) {
+        output += `${statusCode}: ${transformRef(response.$ref)};\n`;
+        return;
+      }
+
+      // option 2: inline schema
       if (response.description) output += comment(response.description);
       if (!response.content || !Object.keys(response.content).length) {
         const type = statusCode === 204 || Math.floor(+statusCode / 100) === 3 ? "never" : "unknown";
@@ -295,11 +303,22 @@ parameters: {
   ${createKeys(propertyMapped, Object.keys(propertyMapped))}
 }`;
   }
+
+  // add responses
   if (components.responses && Object.keys(components.responses).length) {
-    finalOutput += `
-responses: {
-  ${createKeys(components.responses, Object.keys(components.responses))}
-}`;
+    finalOutput += "\nresponses: {\n"; // open response
+    for (const [contentType, responseComplete] of Object.entries(components.responses)) {
+      const { description, ...response } = responseComplete;
+      if (description) finalOutput += comment(description);
+      finalOutput += `  "${contentType}": {\n`; // open content type
+      Object.entries(response).forEach(([property, value]) => {
+        finalOutput += `    "${property}": {\n`; // open property
+        finalOutput += `      ${createKeys(value, Object.keys(value))}\n`;
+        finalOutput += `    }\n`; // close property
+      });
+      finalOutput += "  }\n"; // close content type
+    }
+    finalOutput += "}\n"; // close response
   }
 
   // close components wrapper