feat: type can be omitted when there is enum

plantain-00 · Apr 29, 2018 · 872905b · 872905b
1 parent 9684928
commit 872905b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 11 deletions.
diff --git a/demo/cases.json b/demo/cases.json
@@ -315,7 +315,6 @@
           ]
         },
         "typeUnionMember7": {
-          "type": "string",
           "enum": [
             "foo",
             "bar"
@@ -362,7 +361,6 @@
       "type": "object",
       "properties": {
         "kind": {
-          "type": "string",
           "enum": [
             "enum member 1",
             "enum member 2"
@@ -386,7 +384,6 @@
       "type": "object",
       "properties": {
         "kind": {
-          "type": "integer",
           "enum": [
             0,
             1
@@ -410,7 +407,6 @@
       "type": "object",
       "properties": {
         "kind": {
-          "type": "string",
           "enum": [
             "foo",
             "bar"
@@ -441,7 +437,6 @@
       ]
     },
     "TypeUnion8": {
-      "type": "string",
       "enum": [
         "foo",
         "bar"
@@ -538,7 +533,6 @@
           "type": "number"
         },
         "kind": {
-          "type": "integer",
           "enum": [
             0,
             1

diff --git a/src/json-schema-generator.ts b/src/json-schema-generator.ts
@@ -52,7 +52,7 @@ function getJsonSchemaProperty (memberType: Type | ObjectModel | ArrayModel | Un
   } else if (memberType.kind === 'enum') {
     if (memberType.type === 'string') {
       return {
-        type: 'string',
+        type: undefined,
         enum: memberType.enums
       }
     } else {
@@ -65,6 +65,7 @@ function getJsonSchemaProperty (memberType: Type | ObjectModel | ArrayModel | Un
         minimum: undefined,
         maximum: undefined
       })
+      delete definition.type
       return definition
     }
   } else if (memberType.kind === 'reference') {
@@ -98,13 +99,18 @@ function getJsonSchemaProperty (memberType: Type | ObjectModel | ArrayModel | Un
       maxProperties: memberType.maxProperties && memberType.maxProperties < memberType.members.length ? memberType.maxProperties : undefined
     }
   } else if (memberType.kind === 'string') {
+    if (memberType.enums) {
+      return {
+        type: undefined,
+        enum: memberType.enums
+      }
+    }
     return {
       type: memberType.kind,
       minLength: memberType.minLength,
       maxLength: memberType.maxLength,
       pattern: memberType.pattern,
-      default: memberType.default,
-      enum: memberType.enums
+      default: memberType.default
     }
   } else if (memberType.kind === 'union') {
     return {
@@ -217,7 +223,6 @@ type Definition =
     maximum?: number;
     exclusiveMinimum?: number;
     exclusiveMaximum?: number;
-    enum?: number[],
     multipleOf?: number;
     default?: number;
   }
@@ -249,11 +254,11 @@ type Definition =
     type: undefined,
     $ref?: string,
     anyOf?: Definition[]
+    enum?: string[]
   }
   |
   {
     type: 'string',
-    enum?: string[],
     minLength?: number;
     maxLength?: number;
     pattern?: string;