fix(api): allow overriding request body name with x-body-name key

hey-api · Feb 4, 2024 · d9daebd · d9daebd
1 parent 80f0dbf
commit d9daebd
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 8 deletions.
diff --git a/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts b/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts
@@ -6,8 +6,9 @@ import type { OpenApiReference } from './OpenApiReference';
  * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject
  */
 export interface OpenApiRequestBody extends OpenApiReference {
-    description?: string;
+    'x-body-name'?: string;
     content: Dictionary<OpenApiMediaType>;
-    required?: boolean;
+    description?: string;
     nullable?: boolean;
+    required?: boolean;
 }
diff --git a/src/openApi/v3/parser/getOperationRequestBody.ts b/src/openApi/v3/parser/getOperationRequestBody.ts
@@ -10,8 +10,8 @@ export const getOperationRequestBody = (openApi: OpenApi, body: OpenApiRequestBo
     const requestBody: OperationParameter = {
         in: 'body',
         export: 'interface',
-        prop: 'requestBody',
-        name: 'requestBody',
+        prop: body['x-body-name'] ?? 'requestBody',
+        name: body['x-body-name'] ?? 'requestBody',
         type: 'any',
         base: 'any',
         template: null,

diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -28,7 +28,6 @@ import { writeClientServices } from './writeClientServices';
  * @param exportServices Generate services
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
- * @param exportSchemas Generate schemas
  * @param indent Indentation options (4, 2 or tab)
  * @param postfixServices Service name postfix
  * @param postfixModels Model name postfix

diff --git a/test/__snapshots__/index.spec.ts.snap b/test/__snapshots__/index.spec.ts.snap
@@ -7583,20 +7583,20 @@ import { request as __request } from '../core/request';
 export class RequestBodyService {
     /**
      * @param parameter This is a reusable parameter
-     * @param requestBody A reusable request body
+     * @param foo A reusable request body
      * @throws ApiError
      */
     public static postApiRequestBody(
         parameter?: string,
-        requestBody?: ModelWithString,
+        foo?: ModelWithString,
     ): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/v{api-version}/requestBody/',
             query: {
                 'parameter': parameter,
             },
-            body: requestBody,
+            body: foo,
             mediaType: 'application/json',
         });
     }

diff --git a/test/spec/v3.json b/test/spec/v3.json
@@ -1493,6 +1493,7 @@
     "components": {
         "requestBodies": {
             "SimpleRequestBody": {
+                "x-body-name": "foo",
                 "description": "A reusable request body",
                 "required": false,
                 "content": {