fix(): allow setting default value in api header decorator

minenkom · Jun 22, 2020 · e1174b5 · e1174b5
1 parent 7b77202
commit e1174b5
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 12 deletions.
diff --git a/e2e/src/cats/cats.controller.ts b/e2e/src/cats/cats.controller.ts
@@ -17,7 +17,12 @@ import { PaginationQuery } from './dto/pagination-query.dto';
 @ApiSecurity('basic')
 @ApiBearerAuth()
 @ApiTags('cats')
-@ApiHeader({ name: 'header', required: false, description: 'Test' })
+@ApiHeader({
+  name: 'header',
+  required: false,
+  description: 'Test',
+  schema: { default: 'test' }
+})
 @Controller('cats')
 export class CatsController {
   constructor(private readonly catsService: CatsService) {}

diff --git a/lib/decorators/api-header.decorator.ts b/lib/decorators/api-header.decorator.ts
@@ -1,4 +1,4 @@
-import { isNil } from 'lodash';
+import { isNil, isUndefined, negate, pickBy } from 'lodash';
 import { DECORATORS } from '../constants';
 import {
   ParameterLocation,
@@ -17,15 +17,19 @@ const defaultHeaderOptions: Partial<ApiHeaderOptions> = {
 };
 
 export function ApiHeader(options: ApiHeaderOptions): any {
-  const param: ApiHeaderOptions & { in: ParameterLocation } = {
-    name: isNil(options.name) ? defaultHeaderOptions.name : options.name,
-    in: 'header',
-    description: options.description,
-    required: options.required,
-    schema: {
-      type: 'string'
-    }
-  };
+  const param = pickBy<ApiHeaderOptions & { in: ParameterLocation }>(
+    {
+      name: isNil(options.name) ? defaultHeaderOptions.name : options.name,
+      in: 'header',
+      description: options.description,
+      required: options.required,
+      schema: {
+        ...(options.schema || {}),
+        type: 'string'
+      }
+    },
+    negate(isUndefined)
+  );
 
   if (options.enum) {
     const enumValues = getEnumValues(options.enum);

diff --git a/test/explorer/swagger-explorer.spec.ts b/test/explorer/swagger-explorer.spec.ts
@@ -723,7 +723,10 @@ describe('SwaggerExplorer', () => {
 
     @ApiHeader({
       name: 'Authorization',
-      description: 'auth token'
+      description: 'auth token',
+      schema: {
+        default: 'default token'
+      }
     })
     @Controller('')
     class FooController {
@@ -758,6 +761,7 @@ describe('SwaggerExplorer', () => {
           name: 'Authorization',
           in: 'header',
           schema: {
+            default: 'default token',
             type: 'string'
           }
         },
@@ -776,6 +780,7 @@ describe('SwaggerExplorer', () => {
           name: 'Authorization',
           in: 'header',
           schema: {
+            default: 'default token',
             type: 'string'
           }
         }