fix: operation parameter should override pathItem parameters

Author: julien-tricent

packages/rtk-query-codegen-openapi/src/generate.ts

@@ -175,13 +175,13 @@ export async function generateApi(
         ...apiGen.enumAliases,
         ...(hooks
           ? [
-            generateReactHooks({
-              exportName: generatedApiName,
-              operationDefinitions,
-              endpointOverrides,
-              config: hooks,
-            }),
-          ]
+              generateReactHooks({
+                exportName: generatedApiName,
+                operationDefinitions,
+                endpointOverrides,
+                config: hooks,
+              }),
+            ]
           : []),
       ],
       factory.createToken(ts.SyntaxKind.EndOfFileToken),
@@ -259,10 +259,12 @@ export async function generateApi(
       ).name
     );
 
-    const parameters = supportDeepObjects([
-      ...apiGen.resolveArray(pathItem.parameters),
-      ...apiGen.resolveArray(operation.parameters),
-    ]);
+    const operationParameters = apiGen.resolveArray(operation.parameters);
+    const pathItemParameters = apiGen
+      .resolveArray(pathItem.parameters)
+      .filter((pp) => !operationParameters.some((op) => op.name === pp.name));
+
+    const parameters = supportDeepObjects([...pathItemParameters, ...operationParameters]);
 
     const allNames = parameters.map((p) => p.name);
     const queryArg: QueryArgDefinitions = {};
@@ -301,7 +303,9 @@ export async function generateApi(
       const body = apiGen.resolve(requestBody);
       const schema = apiGen.getSchemaFromContent(body.content);
       const type = apiGen.getTypeFromSchema(schema);
-      const schemaName = camelCase((type as any).name || getReferenceName(schema) || ("title" in schema && schema.title) || 'body');
+      const schemaName = camelCase(
+        (type as any).name || getReferenceName(schema) || ('title' in schema && schema.title) || 'body'
+      );
       const name = generateName(schemaName in queryArg ? 'body' : schemaName, 'body');
 
       queryArg[name] = {
@@ -335,19 +339,19 @@ export async function generateApi(
             ? isFlatArg
               ? withQueryComment({ ...queryArgValues[0].type }, queryArgValues[0], false)
               : factory.createTypeLiteralNode(
-                queryArgValues.map((def) =>
-                  withQueryComment(
-                    factory.createPropertySignature(
-                      undefined,
-                      propertyName(def.name),
-                      createQuestionToken(!def.required),
-                      def.type
-                    ),
-                    def,
-                    true
+                  queryArgValues.map((def) =>
+                    withQueryComment(
+                      factory.createPropertySignature(
+                        undefined,
+                        propertyName(def.name),
+                        createQuestionToken(!def.required),
+                        def.type
+                      ),
+                      def,
+                      true
+                    )
                   )
                 )
-              )
             : factory.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword)
         )
       ).name
@@ -391,18 +395,18 @@ export async function generateApi(
       return parameters.length === 0
         ? undefined
         : factory.createPropertyAssignment(
-          factory.createIdentifier(propertyName),
-          factory.createObjectLiteralExpression(
-            parameters.map(
-              (param) =>
-                createPropertyAssignment(
-                  param.originalName,
-                  isFlatArg ? rootObject : accessProperty(rootObject, param.name)
-                ),
-              true
+            factory.createIdentifier(propertyName),
+            factory.createObjectLiteralExpression(
+              parameters.map(
+                (param) =>
+                  createPropertyAssignment(
+                    param.originalName,
+                    isFlatArg ? rootObject : accessProperty(rootObject, param.name)
+                  ),
+                true
+              )
             )
-          )
-        );
+          );
     }
 
     return factory.createArrowFunction(
@@ -423,17 +427,17 @@ export async function generateApi(
             isQuery && verb.toUpperCase() === 'GET'
               ? undefined
               : factory.createPropertyAssignment(
-                factory.createIdentifier('method'),
-                factory.createStringLiteral(verb.toUpperCase())
-              ),
+                  factory.createIdentifier('method'),
+                  factory.createStringLiteral(verb.toUpperCase())
+                ),
             bodyParameter === undefined
               ? undefined
               : factory.createPropertyAssignment(
-                factory.createIdentifier('body'),
-                isFlatArg
-                  ? rootObject
-                  : factory.createPropertyAccessExpression(rootObject, factory.createIdentifier(bodyParameter.name))
-              ),
+                  factory.createIdentifier('body'),
+                  isFlatArg
+                    ? rootObject
+                    : factory.createPropertyAccessExpression(rootObject, factory.createIdentifier(bodyParameter.name))
+                ),
             createObjectLiteralProperty(pickParams('cookie'), 'cookies'),
             createObjectLiteralProperty(pickParams('header'), 'headers'),
             createObjectLiteralProperty(pickParams('query'), 'params'),
@@ -445,12 +449,12 @@ export async function generateApi(
   }
 
   // eslint-disable-next-line no-empty-pattern
-  function generateQueryEndpointProps({ }: { operationDefinition: OperationDefinition }): ObjectPropertyDefinitions {
+  function generateQueryEndpointProps({}: { operationDefinition: OperationDefinition }): ObjectPropertyDefinitions {
     return {}; /* TODO needs implementation - skip for now */
   }
 
   // eslint-disable-next-line no-empty-pattern
-  function generateMutationEndpointProps({ }: { operationDefinition: OperationDefinition }): ObjectPropertyDefinitions {
+  function generateMutationEndpointProps({}: { operationDefinition: OperationDefinition }): ObjectPropertyDefinitions {
     return {}; /* TODO needs implementation - skip for now */
   }
 }
@@ -480,16 +484,16 @@ function generatePathExpression(
 
   return expressions.length
     ? factory.createTemplateExpression(
-      factory.createTemplateHead(head),
-      expressions.map(([prop, literal], index) =>
-        factory.createTemplateSpan(
-          isFlatArg ? rootObject : accessProperty(rootObject, prop),
-          index === expressions.length - 1
-            ? factory.createTemplateTail(literal)
-            : factory.createTemplateMiddle(literal)
+        factory.createTemplateHead(head),
+        expressions.map(([prop, literal], index) =>
+          factory.createTemplateSpan(
+            isFlatArg ? rootObject : accessProperty(rootObject, prop),
+            index === expressions.length - 1
+              ? factory.createTemplateTail(literal)
+              : factory.createTemplateMiddle(literal)
+          )
         )
       )
-    )
     : factory.createNoSubstitutionTemplateLiteral(head);
 }
 
@@ -500,13 +504,13 @@ type QueryArgDefinition = {
   required?: boolean;
   param?: OpenAPIV3.ParameterObject;
 } & (
-    | {
+  | {
       origin: 'param';
       param: OpenAPIV3.ParameterObject;
     }
-    | {
+  | {
       origin: 'body';
       body: OpenAPIV3.RequestBodyObject;
     }
-  );
+);
 type QueryArgDefinitions = Record<string, QueryArgDefinition>;

packages/rtk-query-codegen-openapi/test/__snapshots__/generateEndpoints.test.ts.snap

@@ -566,15 +566,15 @@ import { api } from './fixtures/emptyApi';
 const injectedRtkApi = api.injectEndpoints({
   endpoints: (build) => ({
     getUsersById: build.query<GetUsersByIdApiResponse, GetUsersByIdApiArg>({
-      query: (queryArg) => ({ url: \`/users/\${queryArg.pathId}\` }),
+      query: (queryArg) => ({ url: \`/users/\${queryArg.id}\` }),
     }),
   }),
   overrideExisting: false,
 });
 export { injectedRtkApi as enhancedApi };
 export type GetUsersByIdApiResponse = unknown;
 export type GetUsersByIdApiArg = {
-  pathId: number;
+  id: number;
 };
 
 `;

packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts

@@ -388,10 +388,8 @@ describe('openapi spec', () => {
 describe('query parameters', () => {
   it('parameters overrided in swagger should also be overrided in the code', async () => {
     const api = await generateEndpoints({
-      unionUndefined: true,
       schemaFile: './fixtures/parameterOverride.yaml',
       apiFile: './fixtures/emptyApi.ts',
-      mergeReadWriteOnly: true,
     });
     expect(api).toMatchSnapshot();
   });