README.md

@@ -8,7 +8,6 @@
   <a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
   <a href="https://www.npmjs.com/~nestjscore"><img src="https://img.shields.io/npm/dm/@nestjs/core.svg" alt="NPM Downloads" /></a>
   <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-  <a href="https://coveralls.io/github/nestjs/nest?branch=master"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#5" alt="Coverage" /></a>
   <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
   <a href="https://opencollective.com/nest#backer"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
   <a href="https://opencollective.com/nest#sponsor"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>

e2e/api-spec.json

@@ -1463,6 +1463,23 @@
               }
             }
           },
+          "rawDefinition": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "example": "ErrorName"
+              },
+              "status": {
+                "type": "number",
+                "example": 400
+              }
+            },
+            "required": [
+              "name",
+              "status"
+            ]
+          },
           "enumWithDescription": {
             "enum": [
               "A",
@@ -1525,6 +1542,7 @@
           "createdAt",
           "urls",
           "options",
+          "rawDefinition",
           "enumWithDescription",
           "enum",
           "enumArr",
@@ -1600,6 +1618,12 @@
               "status"
             ]
           },
+          "optionalRawDefinition": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "boolean"
+            }
+          },
           "enum": {
             "type": "string",
             "enum": [

e2e/src/cats/classes/cat.class.ts

@@ -60,7 +60,14 @@ export class Cat {
     required: ['name', 'status'],
     selfRequired: true
   })
-  rawDefinition?: Record<string, any>;
+  rawDefinition: Record<string, any>;
+
+  @ApiProperty({
+    type: 'object',
+    additionalProperties: { type: 'boolean' },
+    selfRequired: false
+  })
+  optionalRawDefinition?: Record<string, boolean>;
 
   @ApiProperty({
     enum: LettersEnum

e2e/src/cats/dto/create-cat.dto.ts

@@ -44,6 +44,23 @@ export class CreateCatDto {
   })
   readonly options?: Record<string, any>[];
 
+  @ApiProperty({
+    type: 'object',
+    properties: {
+      name: {
+        type: 'string',
+        example: 'ErrorName'
+      },
+      status: {
+        type: 'number',
+        example: 400
+      }
+    },
+    required: ['name', 'status'],
+    selfRequired: true
+  })
+  rawDefinition: Record<string, any>;
+
   @ApiProperty({
     description: 'Enum with description'
   })

e2e/validate-schema.e2e-spec.ts

@@ -10,6 +10,7 @@ import {
   OpenAPIObject,
   SwaggerModule
 } from '../lib';
+import { SchemaObject } from '../lib/interfaces/open-api-spec.interface';
 import { ApplicationModule } from './src/app.module';
 import { Cat } from './src/cats/classes/cat.class';
 import { TagDto } from './src/cats/dto/tag.dto';
@@ -222,4 +223,11 @@ describe('Validate OpenAPI schema', () => {
       }
     });
   });
+
+  it('should not add optional properties to required list', async () => {
+    const document = SwaggerModule.createDocument(app, options);
+    const required = (document.components?.schemas?.Cat as SchemaObject)
+      ?.required;
+    expect(required).not.toContain('optionalRawDefinition');
+  });
 });

lib/services/schema-object-factory.ts

@@ -268,10 +268,10 @@ export class SchemaObjectFactory {
     };
 
     const typeDefinitionRequiredFields = propertiesWithType
-      .filter(
-        (property) =>
-          (property.required != false && !Array.isArray(property.required)) ||
-          ('selfRequired' in property && property.selfRequired != false)
+      .filter((property) =>
+        'selfRequired' in property
+          ? property.selfRequired != false
+          : property.required != false && !Array.isArray(property.required)
       )
       .map((property) => property.name);
 

lib/swagger-explorer.ts

@@ -93,7 +93,12 @@ export class SwaggerExplorer {
       ? `${controllerKey}_${methodKey}_from_${fieldKey}`
       : `${methodKey}_from_${fieldKey}`;
 
-  constructor(private readonly schemaObjectFactory: SchemaObjectFactory) {}
+  constructor(
+    private readonly schemaObjectFactory: SchemaObjectFactory,
+    private readonly options: {
+      httpAdapterType?: string;
+    } = {}
+  ) {}
 
   public exploreController(
     wrapper: InstanceWrapper<Controller>,
@@ -439,7 +444,10 @@ export class SwaggerExplorer {
     let pathWithParams = '';
 
     try {
-      let normalizedPath = LegacyRouteConverter.tryConvert(path);
+      let normalizedPath = LegacyRouteConverter.tryConvert(path, {
+        // Skip logs for Fastify as it has different rules for wildcard routes
+        logs: this.options.httpAdapterType !== 'fastify'
+      });
       // Optional segment groups are not supported by Fastify
       normalizedPath = normalizedPath.replace(/::/g, '\\:');
       normalizedPath = normalizedPath.replace(/\[:\]/g, '\\:');

lib/swagger-scanner.ts

@@ -28,7 +28,7 @@ export class SwaggerScanner {
     new ModelPropertiesAccessor(),
     new SwaggerTypesMapper()
   );
-  private readonly explorer = new SwaggerExplorer(this.schemaObjectFactory);
+  private explorer: SwaggerExplorer | undefined;
 
   public scanApplication(
     app: INestApplication,
@@ -44,8 +44,11 @@ export class SwaggerScanner {
       autoTagControllers = true
     } = options;
 
-    const container = (app as any).container as NestContainer;
-    const internalConfigRef = (app as any).config as ApplicationConfig;
+    const untypedApp = app as any;
+    const container = untypedApp.container as NestContainer;
+    const internalConfigRef = untypedApp.config as ApplicationConfig;
+    const httpAdapterType = app.getHttpAdapter().getType();
+    this.initializeSwaggerExplorer(httpAdapterType);
 
     const modules: Module[] = this.getModules(
       container.getModules(),
@@ -169,4 +172,13 @@ export class SwaggerScanner {
     );
     return modulePath ?? Reflect.getMetadata(MODULE_PATH, metatype);
   }
+
+  private initializeSwaggerExplorer(httpAdapterType: string) {
+    if (this.explorer) {
+      return;
+    }
+    this.explorer = new SwaggerExplorer(this.schemaObjectFactory, {
+      httpAdapterType
+    });
+  }
 }