Merge branch '3294-fix-enum-schema' of github.com:mag123c/swagger into mag123c-3294-fix-enum-schema

Author: kamilmysliwiec

lib/interfaces/open-api-spec.interface.ts

@@ -232,6 +232,7 @@ export interface SchemaObject {
   minProperties?: number;
   required?: string[];
   enum?: any[];
+  'x-enumNames'?: string[];
 }
 
 export type SchemasObject = Record<string, SchemaObject>;

lib/services/schema-object-factory.ts

@@ -64,9 +64,9 @@ export class SchemaObjectFactory {
       if (!isBodyParameter(param)) {
         return this.createQueryOrParamSchema(param, schemas);
       }
-
       return this.getCustomType(param, schemas);
     });
+
     return flatten(parameterObjects);
   }
 
@@ -257,6 +257,10 @@ export class SchemaObjectFactory {
           'selfRequired'
         ];
 
+        if ('$ref' in property) {
+          return omit(pick(property, '$ref'), keysToOmit);
+        }
+
         if ('required' in property && Array.isArray(property.required)) {
           return omit(property, keysToOmit);
         }
@@ -279,6 +283,7 @@ export class SchemaObjectFactory {
       typeDefinition['required'] = typeDefinitionRequiredFields;
     }
     schemas[schemaName] = typeDefinition;
+
     return schemaName;
   }
 
@@ -406,7 +411,9 @@ export class SchemaObjectFactory {
         enum:
           metadata.isArray && metadata.items
             ? metadata.items['enum']
-            : metadata.enum
+            : metadata.enum,
+        description: metadata.description ?? undefined,
+        'x-enumNames': metadata['x-enumNames'] ?? undefined
       };
     } else {
       if (metadata.enumSchema) {
@@ -415,6 +422,10 @@ export class SchemaObjectFactory {
           ...metadata.enumSchema
         };
       }
+
+      if (metadata['x-enumNames']) {
+        schemas[enumName]['x-enumNames'] = metadata['x-enumNames'];
+      }
     }
 
     const _schemaObject = {
@@ -426,6 +437,7 @@ export class SchemaObjectFactory {
     const refHost = metadata.isArray
       ? { items: { $ref } }
       : { allOf: [{ $ref }] };
+
     const paramObject = { ..._schemaObject, ...refHost };
     const pathsToOmit = ['enum', 'enumName', 'enumSchema'];