Merge pull request ferdikoomen#2 from mrlubos/feat/response-204

mrlubos · web-flow · commit feeb52680771 · 2024-01-28T03:47:30.000Z
Optional response type when 204 response exists
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.27.0] - 2024-01-15
+### Fixed
+- Reverted `@apidevtools/json-schema-ref-parser` to version 10.1.0
+
+## [0.26.0] - 2024-01-07
+### Fixed
+- Upgraded dependencies
+
 ## [0.25.0] - 2023-07-05
 ### Fixed
 - Upgraded dependencies
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.26.2",
+    "version": "0.27.0",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
@@ -60,7 +60,7 @@
         "docker": "docker build -t eeelenbaas/openapi-typescript-codegen ."
     },
     "dependencies": {
-        "@apidevtools/json-schema-ref-parser": "^11.1.0",
+        "@apidevtools/json-schema-ref-parser": "^10.1.0",
         "camelcase": "^6.3.0",
         "commander": "^11.1.0",
         "fs-extra": "^11.2.0",
@@ -78,9 +78,9 @@
         "@angular/platform-browser": "17.0.8",
         "@angular/platform-browser-dynamic": "17.0.8",
         "@angular/router": "17.0.8",
-        "@babel/cli": "7.23.4",
-        "@babel/core": "7.23.7",
-        "@babel/preset-env": "7.23.8",
+        "@babel/cli": "7.23.9",
+        "@babel/core": "7.23.9",
+        "@babel/preset-env": "7.23.9",
         "@babel/preset-typescript": "7.23.3",
         "@rollup/plugin-commonjs": "25.0.7",
         "@rollup/plugin-node-resolve": "15.2.3",
@@ -91,13 +91,13 @@
         "@types/fs-extra": "^11.0.4",
         "@types/glob": "8.1.0",
         "@types/jest": "29.5.11",
-        "@types/node": "20.10.8",
+        "@types/node": "20.11.7",
         "@types/node-fetch": "2.6.10",
         "@types/qs": "6.9.11",
-        "@typescript-eslint/eslint-plugin": "6.18.1",
-        "@typescript-eslint/parser": "6.18.1",
+        "@typescript-eslint/eslint-plugin": "6.19.1",
+        "@typescript-eslint/parser": "6.19.1",
         "abort-controller": "3.0.0",
-        "axios": "1.6.5",
+        "axios": "1.6.7",
         "codecov": "3.8.3",
         "cross-spawn": "7.0.3",
         "eslint": "8.56.0",
@@ -110,8 +110,8 @@
         "jest": "29.7.0",
         "jest-cli": "29.7.0",
         "node-fetch": "2.7.0",
-        "prettier": "3.1.1",
-        "puppeteer": "21.7.0",
+        "prettier": "3.2.4",
+        "puppeteer": "21.9.0",
         "qs": "6.11.2",
         "rimraf": "5.0.5",
         "rollup": "4.7.0",
diff --git a/src/openApi/v2/parser/getOperationResponse.ts b/src/openApi/v2/parser/getOperationResponse.ts
@@ -18,8 +18,8 @@ export const getOperationResponse = (
         code: responseCode,
         description: response.description || null,
         export: 'generic',
-        type: 'any',
-        base: 'any',
+        type: responseCode !== 204 ? 'any' : 'void',
+        base: responseCode !== 204 ? 'any' : 'void',
         template: null,
         link: null,
         isDefinition: false,
diff --git a/src/openApi/v2/parser/getOperationResults.ts b/src/openApi/v2/parser/getOperationResults.ts
@@ -12,36 +12,14 @@ const areEqual = (a: Model, b: Model): boolean => {
 export const getOperationResults = (operationResponses: OperationResponse[]): OperationResponse[] => {
     const operationResults: OperationResponse[] = [];
 
-    // Filter out success response codes, but skip "204 No Content"
+    // Filter out success response codes
     operationResponses.forEach(operationResponse => {
         const { code } = operationResponse;
-        if (code && code !== 204 && code >= 200 && code < 300) {
+        if (code && code >= 200 && code < 300) {
             operationResults.push(operationResponse);
         }
     });
 
-    if (!operationResults.length) {
-        operationResults.push({
-            in: 'response',
-            name: '',
-            code: 200,
-            description: '',
-            export: 'generic',
-            type: 'void',
-            base: 'void',
-            template: null,
-            link: null,
-            isDefinition: false,
-            isReadOnly: false,
-            isRequired: false,
-            isNullable: false,
-            imports: [],
-            enum: [],
-            enums: [],
-            properties: [],
-        });
-    }
-
     return operationResults.filter((operationResult, index, arr) => {
         return (
             arr.findIndex(item => {
diff --git a/src/openApi/v3/parser/getOperationResponse.ts b/src/openApi/v3/parser/getOperationResponse.ts
@@ -19,8 +19,8 @@ export const getOperationResponse = (
         code: responseCode,
         description: response.description || null,
         export: 'generic',
-        type: 'any',
-        base: 'any',
+        type: responseCode !== 204 ? 'any' : 'void',
+        base: responseCode !== 204 ? 'any' : 'void',
         template: null,
         link: null,
         isDefinition: false,
diff --git a/src/openApi/v3/parser/getOperationResults.ts b/src/openApi/v3/parser/getOperationResults.ts
@@ -12,36 +12,14 @@ const areEqual = (a: Model, b: Model): boolean => {
 export const getOperationResults = (operationResponses: OperationResponse[]): OperationResponse[] => {
     const operationResults: OperationResponse[] = [];
 
-    // Filter out success response codes, but skip "204 No Content"
+    // Filter out success response codes
     operationResponses.forEach(operationResponse => {
         const { code } = operationResponse;
-        if (code && code !== 204 && code >= 200 && code < 300) {
+        if (code && code >= 200 && code < 300) {
             operationResults.push(operationResponse);
         }
     });
 
-    if (!operationResults.length) {
-        operationResults.push({
-            in: 'response',
-            name: '',
-            code: 200,
-            description: '',
-            export: 'generic',
-            type: 'void',
-            base: 'void',
-            template: null,
-            link: null,
-            isDefinition: false,
-            isReadOnly: false,
-            isRequired: false,
-            isNullable: false,
-            imports: [],
-            enum: [],
-            enums: [],
-            properties: [],
-        });
-    }
-
     return operationResults.filter((operationResult, index, arr) => {
         return (
             arr.findIndex(item => {
diff --git a/test/__snapshots__/index.spec.ts.snap b/test/__snapshots__/index.spec.ts.snap
@@ -2809,6 +2809,16 @@ export class NoContentService {
             url: '/api/v{api-version}/no-content',
         });
     }
+    /**
+     * @returns any Response is a simple number
+     * @throws ApiError
+     */
+    public static callWithResponseAndNoContentResponse(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v{api-version}/multiple-tags/response-and-no-content',
+        });
+    }
 }
 "
 `;
@@ -2913,6 +2923,16 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class ResponseService {
+    /**
+     * @returns any Response is a simple number
+     * @throws ApiError
+     */
+    public static callWithResponseAndNoContentResponse(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v{api-version}/multiple-tags/response-and-no-content',
+        });
+    }
     /**
      * @returns ModelWithString Message for default response
      * @throws ApiError
@@ -7118,6 +7138,16 @@ export class NoContentService {
             url: '/api/v{api-version}/no-content',
         });
     }
+    /**
+     * @returns number Response is a simple number
+     * @throws ApiError
+     */
+    public static callWithResponseAndNoContentResponse(): CancelablePromise<number> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v{api-version}/multiple-tags/response-and-no-content',
+        });
+    }
 }
 "
 `;
@@ -7307,6 +7337,16 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class ResponseService {
+    /**
+     * @returns number Response is a simple number
+     * @throws ApiError
+     */
+    public static callWithResponseAndNoContentResponse(): CancelablePromise<number> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v{api-version}/multiple-tags/response-and-no-content',
+        });
+    }
     /**
      * @returns ModelWithString
      * @throws ApiError
diff --git a/test/spec/v2.json b/test/spec/v2.json
@@ -456,6 +456,30 @@
                 }
             }
         },
+        "/api/v{api-version}/multiple-tags/response-and-no-content": {
+            "get": {
+                "tags": [
+                    "Response",
+                    "NoContent"
+                ],
+                "operationId": "CallWithResponseAndNoContentResponse",
+                "responses": {
+                    "200": {
+                        "description": "Response is a simple number",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "number"
+                                }
+                            }
+                        }
+                    },
+                    "204": {
+                        "description": "Success"
+                    }
+                }
+            }
+        },
         "/api/v{api-version}/multiple-tags/a": {
             "get": {
                 "tags": [
diff --git a/test/spec/v3.json b/test/spec/v3.json
@@ -663,6 +663,30 @@
                 }
             }
         },
+        "/api/v{api-version}/multiple-tags/response-and-no-content": {
+            "get": {
+                "tags": [
+                    "Response",
+                    "NoContent"
+                ],
+                "operationId": "CallWithResponseAndNoContentResponse",
+                "responses": {
+                    "200": {
+                        "description": "Response is a simple number",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "number"
+                                }
+                            }
+                        }
+                    },
+                    "204": {
+                        "description": "Success"
+                    }
+                }
+            }
+        },
         "/api/v{api-version}/multiple-tags/a": {
             "get": {
                 "tags": [
