refactor: improve ApiParam decorator to use shared addEnumSchema

nestjs · Nov 30, 2023 · 508a559 · 508a559
1 parent e373243
commit 508a559
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 17 deletions.
diff --git a/e2e/api-spec.json b/e2e/api-spec.json
@@ -837,12 +837,12 @@
             "required": true,
             "in": "path",
             "schema": {
-              "type": "string",
               "enum": [
                 "A",
                 "B",
                 "C"
-              ]
+              ],
+              "type": "string"
             }
           },
           {

diff --git a/lib/decorators/api-param.decorator.ts b/lib/decorators/api-param.decorator.ts
@@ -5,7 +5,7 @@ import {
   SchemaObject
 } from '../interfaces/open-api-spec.interface';
 import { SwaggerEnumType } from '../types/swagger-enum.type';
-import { getEnumType, getEnumValues } from '../utils/enum.utils';
+import { addEnumSchema, getEnumType, getEnumValues, isEnumDefined } from '../utils/enum.utils';
 import { createParamDecorator } from './helpers';
 
 type ParameterOptions = Omit<ParameterObject, 'in' | 'schema'>;
@@ -29,24 +29,14 @@ const defaultParamOptions: ApiParamOptions = {
 };
 
 export function ApiParam(options: ApiParamOptions): MethodDecorator {
-  const param: Record<string, any> = {
+  const param: ApiParamMetadata & Record<string, any> = {
     name: isNil(options.name) ? defaultParamOptions.name : options.name,
     in: 'path',
     ...omit(options, 'enum')
   };
 
-  const apiParamMetadata = options as ApiParamMetadata;
-  if (apiParamMetadata.enum) {
-    param.schema = param.schema || ({} as SchemaObject);
-
-    const paramSchema = param.schema as SchemaObject;
-    const enumValues = getEnumValues(apiParamMetadata.enum);
-    paramSchema.type = getEnumType(enumValues);
-    paramSchema.enum = enumValues;
-
-    if (apiParamMetadata.enumName) {
-      param.enumName = apiParamMetadata.enumName;
-    }
+  if (isEnumDefined(options)) {
+    addEnumSchema(param, options);
   }
 
   return createParamDecorator(param, defaultParamOptions);

diff --git a/lib/utils/enum.utils.ts b/lib/utils/enum.utils.ts
@@ -66,8 +66,8 @@ export function addEnumSchema(
   const enumValues = getEnumValues(decoratorOptions.enum);
 
   paramDefinition.schema = paramSchema;
-  paramSchema.enum = enumValues;
   paramSchema.type = getEnumType(enumValues);
+  paramSchema.enum = enumValues;
 
   if (decoratorOptions.enumName) {
     paramDefinition.enumName = decoratorOptions.enumName;