Fixed parameter.body on post endpoints - #8.

astahmer · Oct 31, 2023 · 00eb659 · 00eb659
1 parent fd3b80b
commit 00eb659
Show file tree

Hide file tree

Showing 18 changed files with 1,013 additions and 94 deletions.
diff --git a/.changeset/purple-glasses-admire.md b/.changeset/purple-glasses-admire.md
@@ -0,0 +1,5 @@
+---
+"typed-openapi": minor
+---
+
+Fixed parameter.body on post endpoints - #8.
diff --git a/packages/typed-openapi/src/generator.ts b/packages/typed-openapi/src/generator.ts
@@ -143,6 +143,7 @@ const generateEndpointSchemaList = (ctx: GeneratorContext) => {
             ${parameters.query ? `query:  ${parameterObjectToString(parameters.query)},` : ""}
         ${parameters.path ? `path:  ${parameterObjectToString(parameters.path)},` : ""}
         ${parameters.header ? `header:  ${parameterObjectToString(parameters.header)},` : ""}
+        ${parameters.body ? `body:  ${parameterObjectToString(parameters.body)},` : ""}
           }`
           : "parameters: never,"
       }

diff --git a/packages/typed-openapi/src/map-openapi-endpoints.ts b/packages/typed-openapi/src/map-openapi-endpoints.ts
@@ -72,6 +72,7 @@ export const mapOpenApiEndpoints = (doc: OpenAPIObject) => {
 
       // Body
       if (operation.requestBody) {
+        endpoint.meta.hasParameters = true;
         const requestBody = refs.unwrap(operation.requestBody ?? {});
         const content = requestBody.content;
         const matchingMediaType = Object.keys(content).find(isAllowedParamMediaTypes);
@@ -154,7 +155,7 @@ type MutationMethod = "post" | "put" | "patch" | "delete";
 type Method = "get" | "head" | "options" | MutationMethod;
 
 export type EndpointParameters = {
-  body?: Box;
+  body?: Box<BoxRef>;
   query?: Box<BoxRef> | Record<string, AnyBox>;
   header?: Box<BoxRef> | Record<string, AnyBox>;
   path?: Box<BoxRef> | Record<string, AnyBox>;

diff --git a/packages/typed-openapi/tests/generator.test.ts b/packages/typed-openapi/tests/generator.test.ts
@@ -51,13 +51,17 @@ describe("generator", () => {
         export type put_UpdatePet = {
           method: "PUT";
           path: "/pet";
-          parameters: never;
+          parameters: {
+            body: Pet;
+          };
           response: Schemas.Pet;
         };
         export type post_AddPet = {
           method: "POST";
           path: "/pet";
-          parameters: never;
+          parameters: {
+            body: Pet;
+          };
           response: Schemas.Pet;
         };
         export type get_FindPetsByStatus = {
@@ -108,6 +112,8 @@ describe("generator", () => {
           parameters: {
             query: Partial<{ additionalMetadata: string }>;
             path: { petId: number };
+
+            body: string;
           };
           response: Schemas.ApiResponse;
         };
@@ -120,7 +126,9 @@ describe("generator", () => {
         export type post_PlaceOrder = {
           method: "POST";
           path: "/store/order";
-          parameters: never;
+          parameters: {
+            body: Order;
+          };
           response: Schemas.Order;
         };
         export type get_GetOrderById = {
@@ -142,13 +150,17 @@ describe("generator", () => {
         export type post_CreateUser = {
           method: "POST";
           path: "/user";
-          parameters: never;
+          parameters: {
+            body: User;
+          };
           response: Schemas.User;
         };
         export type post_CreateUsersWithListInput = {
           method: "POST";
           path: "/user/createWithList";
-          parameters: never;
+          parameters: {
+            body: Array<User>;
+          };
           response: unknown;
         };
         export type get_LoginUser = {
@@ -178,6 +190,8 @@ describe("generator", () => {
           path: "/user/{username}";
           parameters: {
             path: { username: string };
+
+            body: User;
           };
           response: unknown;
         };

diff --git a/packages/typed-openapi/tests/map-openapi-endpoints.test.ts b/packages/typed-openapi/tests/map-openapi-endpoints.test.ts
@@ -1247,7 +1247,7 @@ describe("map-openapi-endpoints", () => {
             "meta": {
               "alias": "put_UpdatePet",
               "areParametersRequired": false,
-              "hasParameters": false,
+              "hasParameters": true,
             },
             "method": "put",
             "operation": {
@@ -1329,7 +1329,7 @@ describe("map-openapi-endpoints", () => {
             "meta": {
               "alias": "post_AddPet",
               "areParametersRequired": false,
-              "hasParameters": false,
+              "hasParameters": true,
             },
             "method": "post",
             "operation": {
@@ -1907,7 +1907,7 @@ describe("map-openapi-endpoints", () => {
             "meta": {
               "alias": "post_PlaceOrder",
               "areParametersRequired": false,
-              "hasParameters": false,
+              "hasParameters": true,
             },
             "method": "post",
             "operation": {
@@ -2081,7 +2081,7 @@ describe("map-openapi-endpoints", () => {
             "meta": {
               "alias": "post_CreateUser",
               "areParametersRequired": false,
-              "hasParameters": false,
+              "hasParameters": true,
             },
             "method": "post",
             "operation": {
@@ -2145,7 +2145,7 @@ describe("map-openapi-endpoints", () => {
             "meta": {
               "alias": "post_CreateUsersWithListInput",
               "areParametersRequired": false,
-              "hasParameters": false,
+              "hasParameters": true,
             },
             "method": "post",
             "operation": {