refactor(@nestjs/swagger): rename the option to patchDocumentOnRequest

Rename the option as pointed out here. #2505 (comment)
nestjs · Jun 30, 2023 · 83c3e8d · 83c3e8d
1 parent ab23696
commit 83c3e8d
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 20 deletions.
diff --git a/e2e/express.e2e-spec.ts b/e2e/express.e2e-spec.ts
@@ -114,7 +114,7 @@ describe('Express Swagger', () => {
       SwaggerModule.setup('api', app, swaggerDocument, {
         jsonDocumentUrl: JSON_CUSTOM_URL,
         yamlDocumentUrl: YAML_CUSTOM_URL,
-        patchDocument: (req, res, document) => ({
+        patchDocumentOnRequest: (req, res, document) => ({
           ...document,
           info: {
             ...document.info,
@@ -232,7 +232,7 @@ describe('Express Swagger', () => {
         customfavIcon: CUSTOM_FAVICON,
         customSiteTitle: CUSTOM_SITE_TITLE,
         customCssUrl: CUSTOM_CSS_URL,
-        patchDocument<ExpressRequest, ExpressResponse> (req, res, document) {
+        patchDocumentOnRequest<ExpressRequest, ExpressResponse> (req, res, document) {
           return {
             ...document,
             info: {
@@ -301,7 +301,7 @@ describe('Express Swagger', () => {
       );
 
       SwaggerModule.setup('/:customer/', app, swaggerDocument, {
-        patchDocument<ExpressRequest, ExpressResponse> (req, res, document) {
+        patchDocumentOnRequest<ExpressRequest, ExpressResponse> (req, res, document) {
           return {
             ...document,
             info: {

diff --git a/e2e/fastify.e2e-spec.ts b/e2e/fastify.e2e-spec.ts
@@ -117,7 +117,7 @@ describe('Fastify Swagger', () => {
       SwaggerModule.setup('api', app, swaggerDocument, {
         jsonDocumentUrl: JSON_CUSTOM_URL,
         yamlDocumentUrl: YAML_CUSTOM_URL,
-        patchDocument: (req, res, document) => ({
+        patchDocumentOnRequest: (req, res, document) => ({
           ...document,
           info: {
             ...document.info,
@@ -237,7 +237,7 @@ describe('Fastify Swagger', () => {
         customfavIcon: CUSTOM_FAVICON,
         customSiteTitle: CUSTOM_SITE_TITLE,
         customCssUrl: CUSTOM_CSS_URL,
-        patchDocument: (req, res, document) => ({
+        patchDocumentOnRequest: (req, res, document) => ({
           ...document,
           info: {
             ...document.info,
@@ -318,7 +318,7 @@ describe('Fastify Swagger', () => {
       );
 
       SwaggerModule.setup('/:tenantId/', app, swaggerDocument, {
-        patchDocument<ExpressRequest, ExpressResponse> (req, res, document) {
+        patchDocumentOnRequest<ExpressRequest, ExpressResponse> (req, res, document) {
           return {
             ...document,
             info: {

diff --git a/e2e/manual-e2e.ts b/e2e/manual-e2e.ts
@@ -124,7 +124,7 @@ async function bootstrap() {
   });
 
   SwaggerModule.setup("/:tenantId/api-docs", app, document, {
-    patchDocument: (req, res, document1) => ({
+    patchDocumentOnRequest: (req, res, document1) => ({
       ...document1,
       info: {
         ...document1.info,

diff --git a/lib/interfaces/swagger-custom-options.interface.ts b/lib/interfaces/swagger-custom-options.interface.ts
@@ -18,5 +18,5 @@ export interface SwaggerCustomOptions {
   urls?: Record<'url' | 'name', string>[];
   jsonDocumentUrl?: string;
   yamlDocumentUrl?: string;
-  patchDocument?: <TRequest = any, TResponse = any> (req: TRequest, res: TResponse, document: OpenAPIObject) => OpenAPIObject;
+  patchDocumentOnRequest?: <TRequest = any, TResponse = any> (req: TRequest, res: TResponse, document: OpenAPIObject) => OpenAPIObject;
 }
diff --git a/lib/swagger-module.ts b/lib/swagger-module.ts
@@ -103,8 +103,8 @@ export class SwaggerModule {
         if (!document) {
           document = lazyBuildDocument();
 
-          if (options.swaggerOptions.patchDocument) {
-            document = options.swaggerOptions.patchDocument(req, res, document);
+          if (options.swaggerOptions.patchDocumentOnRequest) {
+            document = options.swaggerOptions.patchDocumentOnRequest(req, res, document);
           }
         }
 
@@ -131,8 +131,8 @@ export class SwaggerModule {
           if (!document) {
             document = lazyBuildDocument();
 
-            if (options.swaggerOptions.patchDocument) {
-              document = options.swaggerOptions.patchDocument(
+            if (options.swaggerOptions.patchDocumentOnRequest) {
+              document = options.swaggerOptions.patchDocumentOnRequest(
                 req,
                 res,
                 document
@@ -163,8 +163,8 @@ export class SwaggerModule {
       if (!document) {
         document = lazyBuildDocument();
 
-        if (options.swaggerOptions.patchDocument) {
-          document = options.swaggerOptions.patchDocument(req, res, document);
+        if (options.swaggerOptions.patchDocumentOnRequest) {
+          document = options.swaggerOptions.patchDocumentOnRequest(req, res, document);
         }
       }
 
@@ -187,8 +187,8 @@ export class SwaggerModule {
         if (!document) {
           document = lazyBuildDocument();
 
-          if (options.swaggerOptions.patchDocument) {
-            document = options.swaggerOptions.patchDocument(req, res, document);
+          if (options.swaggerOptions.patchDocumentOnRequest) {
+            document = options.swaggerOptions.patchDocumentOnRequest(req, res, document);
           }
         }
 
@@ -220,8 +220,8 @@ export class SwaggerModule {
       if (!document) {
         document = lazyBuildDocument();
 
-        if (options.swaggerOptions.patchDocument) {
-          document = options.swaggerOptions.patchDocument(req, res, document);
+        if (options.swaggerOptions.patchDocumentOnRequest) {
+          document = options.swaggerOptions.patchDocumentOnRequest(req, res, document);
         }
       }
 
@@ -238,8 +238,8 @@ export class SwaggerModule {
       if (!document) {
         document = lazyBuildDocument();
 
-        if (options.swaggerOptions.patchDocument) {
-          document = options.swaggerOptions.patchDocument(req, res, document);
+        if (options.swaggerOptions.patchDocumentOnRequest) {
+          document = options.swaggerOptions.patchDocumentOnRequest(req, res, document);
         }
       }