Merge pull request #2 from JaredAAT/attempt-to-convert-default-values

Attempt to convert default values

Author: JaredAAT

src/Convertor.js

@@ -89,9 +89,37 @@ class Convertor {
                 }
             }
 
+            const convertDefaultValues = () => {
+                if (schema.type === 'boolean') {
+                    if (schema.default === 'true' || schema.default === 'false') {
+                        if (schema.default === 'true')
+                            schema.default = true
+                        else
+                            schema.default = false
+                    }
+                }
+
+                if (schema.type === 'number' || schema.type === 'integer') {
+                    if (typeof schema.default === 'string') {
+                        schema.default = parseInt(schema.default, 10)
+                    }
+                }
+
+                if (schema.type === 'array' && schema.items === undefined) {
+                    schema.items = {nullable: true}
+                }
+
+                if (schema.type === 'string') {
+                    if (Object.keys(schema).indexOf('default')) {
+                        schema.default = `${schema.default}`
+                    }
+                }
+            }
+
             convertNull()
             convertTypeArrays()
             bannedWordsRemoval()
+            convertDefaultValues()
 
             if (this.specialProperties.indexOf(parentKeyword) !== -1) {
                 if (this.ofProperties.indexOf(parentKeyword) !== -1) {

test/schemas/complex-defaultValues.json

@@ -0,0 +1,29 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "JSON API Schema",
+    "description": "This is a schema for responses in the JSON API format. For more, see http://jsonapi.org",
+    "type": "object",
+    "required": [
+        "errors"
+    ],
+    "properties": {
+        "errors": {
+            "type": "object"
+        },
+        "Price": {
+            "type": "number",
+            "default": "100"
+        },
+        "VAT": {
+            "type": "integer",
+            "default": "20"
+        },
+        "hasPrice": {
+            "type": "boolean",
+            "default": "true"
+        },
+        "things": {
+            "type": "array"
+        }
+    }
+}

test/src/Convertor.spec.js

@@ -21,6 +21,7 @@ const complexPropertyDefinitionSchema = require('../schemas/complex-propertyDefi
 const complexResolvedDefinitionSchema = require('../schemas/complex-resolvedDefinition')
 const complexNullTypeSchema = require('../schemas/complex-null')
 const complexTypeArraySchema = require('../schemas/complex-typeArray')
+const complexDefaultValuesSchema = require('../schemas/complex-defaultValues')
 
 const simpleOpenAPI = require('../openAPI/simple')
 
@@ -41,6 +42,7 @@ describe('Convertor', () => {
         delete require.cache[require.resolve('../schemas/complex-resolvedDefinition')];
         delete require.cache[require.resolve('../schemas/complex-null')];
         delete require.cache[require.resolve('../schemas/complex-typeArray')];
+        delete require.cache[require.resolve('../schemas/complex-defaultValues')];
         convertor = new Convertor(simpleSchema)
     });
 
@@ -416,6 +418,29 @@ describe('Convertor', () => {
         });
     });
 
+    describe('convert a schema with default values that are incorrectly defined', () => {
+        it('should return a schema valid for OpenAPI v3.0.0', async function() {
+            const complexConvertor = new Convertor(complexDefaultValuesSchema)
+            const components = complexConvertor.convert()
+
+            const cloned = JSON.parse(JSON.stringify(simpleOpenAPI))
+            let valid = await validator.validateInner(cloned, {})
+            expect(valid).to.be.true
+            Object.assign(cloned, {components})
+            expect(cloned).to.have.property('components')
+            expect(cloned.components).to.have.property('schemas')
+            expect(cloned.components.schemas).to.have.property('main')
+            expect(cloned.components.schemas.main).to.not.have.property('definitions')
+            expect(cloned.components.schemas.main.properties.Price.default).to.be.equal(100)
+            expect(cloned.components.schemas.main.properties.hasPrice.default).to.be.true
+            valid = await validator.validateInner(cloned, {})
+                .catch(err => {
+                    console.log(err)
+                })
+            expect(valid).to.be.true
+        });
+    });
+
     describe('use a repo with lots of schemas to find failing ones', () => {
         xit('should convert all schemas successfully', async function() {
             this.timeout(5000);