fix: clean up parent-metadata and parent-additional-properties from query params (#372)

Author: timonrieger

packages/nestjs-zod/src/__e2e_tests__/openapi.test.ts

@@ -148,6 +148,42 @@ describe('basic query params', () => {
   });
 });
 
+describe('issue#397', () => {
+  test('cleans up description marker', async () => {
+    class QueryParamsDto extends createZodDto(
+      z
+        .object({
+          filter: z.string(),
+        })
+        .describe('My query params'),
+    ) {}
+
+    @Controller()
+    class BookController {
+      constructor() {}
+
+      @Get()
+      getBooks(@Query() _query: QueryParamsDto) {
+        return [];
+      }
+    }
+
+    const doc = await getSwaggerDoc(BookController, { cleanUp: true });
+
+    expect(get(doc, 'paths./.get.parameters')).toEqual([
+      {
+        in: 'query',
+        name: 'filter',
+        required: true,
+        schema: {
+          type: 'string',
+        },
+      },
+    ]);
+    expect(JSON.stringify(doc)).not.toContain(PREFIX);
+  });
+});
+
 describe('unions', () => {
   test('v4', async () => {
     class BookDto extends createZodDto(

packages/nestjs-zod/src/cleanupOpenApiDoc.ts

@@ -541,6 +541,14 @@ function fixParameter(
     delete parameter[PARENT_ID_KEY];
   }
 
+  if (PARENT_METADATA_KEY in parameter) {
+    delete parameter[PARENT_METADATA_KEY];
+  }
+
+  if (PARENT_ADDITIONAL_PROPERTIES_KEY in parameter) {
+    delete parameter[PARENT_ADDITIONAL_PROPERTIES_KEY];
+  }
+
   if (PARENT_HAS_REFS_KEY in parameter) {
     delete parameter[PARENT_HAS_REFS_KEY];