Merge pull request #23 from JaredCE/move-default-into-of-properties

Move default into of properties

Author: JaredCE

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-for-openapi",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Converts a regular JSON Schema to a compatible OpenAPI 3.0.X Schema Object",
   "keywords": [
     "json",

package.json

@@ -119,6 +119,7 @@ class Convertor {
         this.removeEmptyRequired(schema)
         this.convertNullProperty(schema)
         this.convertDefaultValues(schema)
+        this.pullOrphanedPropertiesIntoOneAnyAllOf(schema)
         this.convertOneOfAnyOfNulls(schema)
         this.removeInvalidFields(schema)
     }
@@ -444,6 +445,36 @@ class Convertor {
             }
         }
     }
+
+    pullOrphanedPropertiesIntoOneAnyAllOf(schema) {
+        const properties = ['default']
+
+        const addItem = (intersection, schemaOf) => {
+            for (const property of intersection) {
+                for (const item of schemaOf) {
+                    item[property] = schema[property]
+                }
+            }
+        }
+
+        if (schema.allOf || schema.anyOf || schema.oneOf) {
+            const intersection = Object.keys(schema).filter(property => properties.includes(property))
+
+            if (intersection.length) {
+                if (schema.allOf) {
+                    addItem(intersection, schema.allOf)
+                } else if (schema.oneOf) {
+                    addItem(intersection, schema.oneOf)
+                } else {
+                    addItem(intersection, schema.anyOf)
+                }
+            }
+
+            for (const property of intersection) {
+                delete schema[property]
+            }
+        }
+    }
 }
 
 module.exports = Convertor

src/Convertor.js

@@ -0,0 +1,16 @@
+{
+    "$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",
+    "properties": {
+        "payment": {
+            "allOf": [
+                {
+                    "type": "string"
+                }
+            ],
+            "default": "one"
+        }
+    }
+}

test/schemas/propertiesOutsideOf/allOf.json

@@ -0,0 +1,19 @@
+{
+    "$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",
+    "properties": {
+        "payment": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "number"
+                }
+            ],
+            "default": "one"
+        }
+    }
+}

test/schemas/propertiesOutsideOf/anyOf.json

@@ -0,0 +1,16 @@
+{
+    "$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",
+    "properties": {
+        "payment": {
+            "oneOf": [
+                {
+                    "type": "string"
+                }
+            ],
+            "default": "one"
+        }
+    }
+}

test/schemas/propertiesOutsideOf/oneOf.json

@@ -53,6 +53,11 @@ const listOfBannedSchemas = require('../schemas/SchemasThatCannotBeConverted/lis
 // anyOf/oneOf Nulls
 const oneOfNull = require('../schemas/ofNulls/oneOfNull.json')
 const anyOfNull = require('../schemas/ofNulls/anyOfNull.json')
+// anyOf/oneOf Nulls
+const allOfProperties = require('../schemas/propertiesOutsideOf/allOf.json')
+const oneOfProperties = require('../schemas/propertiesOutsideOf/oneOf.json')
+const anyOfProperties = require('../schemas/propertiesOutsideOf/anyOf.json')
+
 
 // OpenAPI
 const basicOpenAPI = require('../openAPI/basic.json')
@@ -633,6 +638,67 @@ describe('Convertor', () => {
             });
         });
 
+        describe(`properties that exist outside of a oneOf|anyOf|allOf`, function () {
+            it(`should put the property outside of an oneOf into the oneOf`, async function() {
+                const newConvertor = new Convertor(oneOfProperties)
+                const result = newConvertor.convert('basic')
+                expect(result.schemas.basic.properties.payment).to.have.property('oneOf')
+                expect(result.schemas.basic.properties.payment.oneOf).to.be.an('array')
+                expect(result.schemas.basic.properties.payment.oneOf.length).to.be.equal(1)
+                expect(result.schemas.basic.properties.payment).to.not.have.property('default')
+                expect(result.schemas.basic.properties.payment.oneOf[0]).to.have.property('default')
+                expect(result.schemas.basic.properties.payment.oneOf[0].default).to.be.equal('one')
+
+                const cloned = JSON.parse(JSON.stringify(basicOpenAPI))
+                Object.assign(cloned, {components: result})
+                expect(cloned).to.have.property('components')
+                expect(cloned.components).to.have.property('schemas')
+                expect(cloned.components.schemas).to.have.property('basic')
+                let valid = await validator.validateInner(cloned, {})
+                expect(valid).to.be.true
+            });
+
+            it(`should put the property outside of an anyOf into the anyOf`, async function() {
+                const newConvertor = new Convertor(anyOfProperties)
+                const result = newConvertor.convert('basic')
+                expect(result.schemas.basic.properties.payment).to.have.property('anyOf')
+                expect(result.schemas.basic.properties.payment.anyOf).to.be.an('array')
+                expect(result.schemas.basic.properties.payment.anyOf.length).to.be.equal(2)
+                expect(result.schemas.basic.properties.payment).to.not.have.property('default')
+                expect(result.schemas.basic.properties.payment.anyOf[0]).to.have.property('default')
+                expect(result.schemas.basic.properties.payment.anyOf[0].default).to.be.equal('one')
+                expect(result.schemas.basic.properties.payment.anyOf[1]).to.have.property('default')
+                expect(result.schemas.basic.properties.payment.anyOf[1].default).to.be.equal(1)
+
+                const cloned = JSON.parse(JSON.stringify(basicOpenAPI))
+                Object.assign(cloned, {components: result})
+                expect(cloned).to.have.property('components')
+                expect(cloned.components).to.have.property('schemas')
+                expect(cloned.components.schemas).to.have.property('basic')
+                let valid = await validator.validateInner(cloned, {})
+                expect(valid).to.be.true
+            });
+
+            it(`should put the property outside of an allOf into the allOf`, async function() {
+                const newConvertor = new Convertor(allOfProperties)
+                const result = newConvertor.convert('basic')
+                expect(result.schemas.basic.properties.payment).to.have.property('allOf')
+                expect(result.schemas.basic.properties.payment.allOf).to.be.an('array')
+                expect(result.schemas.basic.properties.payment.allOf.length).to.be.equal(1)
+                expect(result.schemas.basic.properties.payment).to.not.have.property('default')
+                expect(result.schemas.basic.properties.payment.allOf[0]).to.have.property('default')
+                expect(result.schemas.basic.properties.payment.allOf[0].default).to.be.equal('one')
+
+                const cloned = JSON.parse(JSON.stringify(basicOpenAPI))
+                Object.assign(cloned, {components: result})
+                expect(cloned).to.have.property('components')
+                expect(cloned.components).to.have.property('schemas')
+                expect(cloned.components.schemas).to.have.property('basic')
+                let valid = await validator.validateInner(cloned, {})
+                expect(valid).to.be.true
+            });
+        });
+
         xdescribe('use a repo with lots of schemas to find failing ones', () => {
             it('should convert all schemas successfully', async function() {
                 this.timeout(1000000);