Merge pull request #11 from JaredCE/make-nulls-nullable

Update Convertor.js

Author: JaredCE

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-for-openapi",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Converts a regular JSON Schema to a compatible OpenAPI 3 Schema Object, extracting out $ref schemas to their own schema object",
   "keywords": [
     "json",

package.json

@@ -11,7 +11,7 @@ class Convertor {
         this.specialProperties = ['allOf', 'anyOf', 'items', 'oneOf', 'not', 'properties']
         this.ofProperties = ['allOf', 'anyOf', 'oneOf']
         this.referencedSchemas = {}
-        this.bannedKeyWords = ['$schema', '$comment', '$id', 'version']
+        this.bannedKeyWords = ['$schema', '$comment', '$id', 'version', 'examples']
 
         this.components = {
             schemas: {}
@@ -54,6 +54,15 @@ class Convertor {
             }
 
             bannedWordsRemoval()
+            
+            const convertNull = () => {
+                if (schema.type === 'null') {
+                    schema.nullable = true
+                    delete schema.type
+                }
+            }
+
+            convertNull()
 
             if (this.specialProperties.indexOf(parentKeyword) !== -1) {
                 if (this.ofProperties.indexOf(parentKeyword) !== -1) {

src/Convertor.js

@@ -0,0 +1,33 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "$id": "http://example.com/build/complex-null.json",
+    "version": "1.1.1",
+    "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",
+            "properties": {
+                "message": {
+                    "oneOf": [
+                        {
+                            "$ref": "#/definitions/message"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ]
+                }
+            }
+        }
+    },
+    "definitions": {
+        "message": {
+            "type": "string"
+        }
+    }
+}

test/schemas/complex-null.json

@@ -18,6 +18,7 @@ const moreComplexOneOfSchema = require('../schemas/morecomplex-oneOf')
 const complexPropertySchema = require('../schemas/complex-property')
 const complexPropertyDefinitionSchema = require('../schemas/complex-propertyDefinition')
 const complexResolvedDefinitionSchema = require('../schemas/complex-resolvedDefinition')
+const complexNullTypeSchema = require('../schemas/complex-null')
 
 const simpleOpenAPI = require('../openAPI/simple')
 
@@ -36,6 +37,7 @@ describe('Convertor', () => {
         delete require.cache[require.resolve('../schemas/complex-property')];
         delete require.cache[require.resolve('../schemas/complex-propertyDefinition')];
         delete require.cache[require.resolve('../schemas/complex-resolvedDefinition')];
+        delete require.cache[require.resolve('../schemas/complex-null')];
         convertor = new Convertor(simpleSchema)
     });
 
@@ -369,4 +371,24 @@ describe('Convertor', () => {
             expect(valid).to.be.true
         });
     });
+    
+    describe('convert a schema with null types', () => {
+        it('should return a schema valid for OpenAPI v3.0.0', async function() {
+            const complexConvertor = new Convertor(complexNullTypeSchema)
+            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')
+            valid = await validator.validateInner(cloned, {})
+                .catch(err => {
+                    console.log(err)
+                })
+            expect(valid).to.be.true
+        });
+    });
 });