fix(oas2): adds explicit "$schema" property in the generated schema

Author: artem-zakharchenko

packages/fury-adapter-swagger/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Fury Swagger Parser Changelog
 
+## 0.28.1 (2020-01-30)
+
+### Bug Fixes
+
+- Sets an explicit `$schema` property on JSON Schema generated from a Swagger
+  document in `convertSchema`. Sets a JSON Schema Draft V4 as the value of the
+  `$schema` property, making generated schema implement a JSON Schema Draft V4.
+
 ## 0.28.0 (2019-12-06)
 
 ### Enhancements

packages/fury-adapter-swagger/lib/json-schema.js

@@ -345,6 +345,8 @@ const convertSchema = (schema, root, swagger, copyDefinitions = true) => {
   const result = convertSubSchema(schema, references, swagger);
 
   if (copyDefinitions) {
+    result.$schema = 'http://json-schema.org/draft-04/schema#';
+
     if (references.length !== 0) {
       result.definitions = {};
     }

packages/fury-adapter-swagger/test/fixtures/auth-multi-consumes.json

@@ -169,7 +169,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\"}"
+                          "content": "{\"type\":\"object\",\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",
@@ -273,7 +273,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\"}"
+                          "content": "{\"type\":\"object\",\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/consumes-invalid-type.json

@@ -68,7 +68,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\"}"
+                          "content": "{\"type\":\"object\",\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/data-structure-generation-nullable-member.json

@@ -91,7 +91,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":[\"string\",\"null\"]}}}"
+                          "content": "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":[\"string\",\"null\"]}},\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/data-structure-generation-ref.json

@@ -91,7 +91,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"$ref\":\"#/definitions/User\"}},\"examples\":[{\"id\":123,\"user\":{\"name\":\"Doe\"}}],\"definitions\":{\"User\":{\"type\":\"object\",\"examples\":[{\"name\":\"Doe\"}]}}}"
+                          "content": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"$ref\":\"#/definitions/User\"}},\"examples\":[{\"id\":123,\"user\":{\"name\":\"Doe\"}}],\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"User\":{\"type\":\"object\",\"examples\":[{\"name\":\"Doe\"}]}}}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/data-structure-generation.json

@@ -91,7 +91,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\",\"examples\":[\"doe\"]}},\"examples\":[{\"id\":123,\"name\":\"doe\"}]}"
+                          "content": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\"},\"name\":{\"type\":\"string\",\"examples\":[\"doe\"]}},\"examples\":[{\"id\":123,\"name\":\"doe\"}],\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/json-body-generation-array-object.json

@@ -202,7 +202,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Question\"},\"definitions\":{\"Question\":{\"title\":\"Question\",\"type\":\"object\",\"properties\":{\"question\":{\"type\":\"string\",\"examples\":[\"hi\"]},\"published_at\":{\"type\":\"string\",\"examples\":[2019]},\"choices\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Choice\"}}},\"required\":[\"question\",\"published_at\",\"choices\"]},\"Choice\":{\"title\":\"Choice\",\"type\":\"object\",\"properties\":{\"votes\":{\"type\":\"integer\",\"format\":\"int32\",\"examples\":[512]},\"choice\":{\"type\":\"string\",\"examples\":[\"Swift\"]}},\"required\":[\"votes\",\"choice\"]}}}"
+                          "content": "{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Question\"},\"$schema\":\"http://json-schema.org/draft-04/schema#\",\"definitions\":{\"Question\":{\"title\":\"Question\",\"type\":\"object\",\"properties\":{\"question\":{\"type\":\"string\",\"examples\":[\"hi\"]},\"published_at\":{\"type\":\"string\",\"examples\":[2019]},\"choices\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/definitions/Choice\"}}},\"required\":[\"question\",\"published_at\",\"choices\"]},\"Choice\":{\"title\":\"Choice\",\"type\":\"object\",\"properties\":{\"votes\":{\"type\":\"integer\",\"format\":\"int32\",\"examples\":[512]},\"choice\":{\"type\":\"string\",\"examples\":[\"Swift\"]}},\"required\":[\"votes\",\"choice\"]}}}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/json-body-generation-bad-pattern.json

@@ -196,7 +196,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"string\",\"minLength\":1,\"maxLength\":255,\"pattern\":\"^[A-z]+$\"}"
+                          "content": "{\"type\":\"string\",\"minLength\":1,\"maxLength\":255,\"pattern\":\"^[A-z]+$\",\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",

packages/fury-adapter-swagger/test/fixtures/json-body-generation.json

@@ -206,7 +206,7 @@
                               "content": "application/schema+json"
                             }
                           },
-                          "content": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\",\"examples\":[1]},\"name\":{\"type\":\"string\",\"examples\":[\"doe\"]}}}"
+                          "content": "{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"number\",\"examples\":[1]},\"name\":{\"type\":\"string\",\"examples\":[\"doe\"]}},\"$schema\":\"http://json-schema.org/draft-04/schema#\"}"
                         },
                         {
                           "element": "dataStructure",