schema-inference: do not mark any property as required

estuary · May 31, 2023 · c209ee2 · c209ee2
1 parent 34a62de
commit c209ee2
Show file tree

Hide file tree

Showing 17 changed files with 3 additions and 103 deletions.
diff --git a/crates/schema-inference/src/inference.rs b/crates/schema-inference/src/inference.rs
@@ -95,7 +95,9 @@ fn infer_object(inner: &serde_json::Map<String, JsonValue>) -> Shape {
         .iter()
         .map(|(key, value)| ObjProperty {
             name: key.to_owned(),
-            is_required: true,
+            // We don't mark any non-key property as required since it is hard to revert requirement on a
+            // property if we later realise that this value can sometimes be null
+            is_required: false,
             shape: infer_shape(value),
         })
         .collect();

diff --git a/...erence/src/snapshots/schema_inference__analyze__test__generator_with_multiple_values.snap b/...erence/src/snapshots/schema_inference__analyze__test__generator_with_multiple_values.snap
@@ -6,12 +6,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a_null_value",
-    "boolean",
-    "number",
-    "string"
-  ],
   "properties": {
     "a_null_value": {
       "type": "null"

diff --git a/crates/schema-inference/src/snapshots/schema_inference__analyze__test__multi_merging.snap b/crates/schema-inference/src/snapshots/schema_inference__analyze__test__multi_merging.snap
@@ -6,21 +6,12 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a",
-    "b",
-    "c"
-  ],
   "properties": {
     "a": {
       "type": [
         "integer",
         "object"
       ],
-      "required": [
-        "imaginary",
-        "real"
-      ],
       "properties": {
         "imaginary": {
           "type": "integer"
@@ -37,9 +28,6 @@ expression: schema
           "boolean",
           "object"
         ],
-        "required": [
-          "truthful"
-        ],
         "properties": {
           "harmless": {
             "type": "string"
@@ -58,9 +46,6 @@ expression: schema
     },
     "c": {
       "type": "object",
-      "required": [
-        "inner"
-      ],
       "properties": {
         "even_more_optional": {
           "type": "boolean"
@@ -71,9 +56,6 @@ expression: schema
             "object",
             "string"
           ],
-          "required": [
-            "details"
-          ],
           "properties": {
             "details": {
               "type": "string"

diff --git a/crates/schema-inference/src/snapshots/schema_inference__analyze__test__nested_values.snap b/crates/schema-inference/src/snapshots/schema_inference__analyze__test__nested_values.snap
@@ -6,19 +6,9 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "author",
-    "id",
-    "tags",
-    "title"
-  ],
   "properties": {
     "author": {
       "type": "object",
-      "required": [
-        "contact",
-        "name"
-      ],
       "properties": {
         "contact": {
           "type": "string"

diff --git a/...chema-inference/src/snapshots/schema_inference__analyze__test__simple_schema_merging.snap b/...chema-inference/src/snapshots/schema_inference__analyze__test__simple_schema_merging.snap
@@ -6,12 +6,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a",
-    "b",
-    "c",
-    "s"
-  ],
   "properties": {
     "a": {
       "type": "integer"
@@ -27,9 +21,6 @@ expression: schema
     },
     "c": {
       "type": "object",
-      "required": [
-        "inner"
-      ],
       "properties": {
         "inner": {
           "type": [
@@ -48,9 +39,6 @@ expression: schema
         "object",
         "string"
       ],
-      "required": [
-        "sometimes"
-      ],
       "properties": {
         "sometimes": {
           "type": "string"

diff --git a/...rence/src/snapshots/schema_inference__analyze__test__string_format_integer_merging-2.snap b/...rence/src/snapshots/schema_inference__analyze__test__string_format_integer_merging-2.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...ference/src/snapshots/schema_inference__analyze__test__string_format_integer_merging.snap b/...ference/src/snapshots/schema_inference__analyze__test__string_format_integer_merging.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...src/snapshots/schema_inference__analyze__test__string_format_number_back_to_string-2.snap b/...src/snapshots/schema_inference__analyze__test__string_format_number_back_to_string-2.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...e/src/snapshots/schema_inference__analyze__test__string_format_number_back_to_string.snap b/...e/src/snapshots/schema_inference__analyze__test__string_format_number_back_to_string.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...erence/src/snapshots/schema_inference__analyze__test__string_format_number_merging-2.snap b/...erence/src/snapshots/schema_inference__analyze__test__string_format_number_merging-2.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...erence/src/snapshots/schema_inference__analyze__test__string_format_number_merging-3.snap b/...erence/src/snapshots/schema_inference__analyze__test__string_format_number_merging-3.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...erence/src/snapshots/schema_inference__analyze__test__string_format_number_merging-4.snap b/...erence/src/snapshots/schema_inference__analyze__test__string_format_number_merging-4.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...nference/src/snapshots/schema_inference__analyze__test__string_format_number_merging.snap b/...nference/src/snapshots/schema_inference__analyze__test__string_format_number_merging.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...rc/snapshots/schema_inference__analyze__test__string_format_number_special_strings-2.snap b/...rc/snapshots/schema_inference__analyze__test__string_format_number_special_strings-2.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/...rc/snapshots/schema_inference__analyze__test__string_format_number_special_strings-3.snap b/...rc/snapshots/schema_inference__analyze__test__string_format_number_special_strings-3.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/.../src/snapshots/schema_inference__analyze__test__string_format_number_special_strings.snap b/.../src/snapshots/schema_inference__analyze__test__string_format_number_special_strings.snap
@@ -5,9 +5,6 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a"
-  ],
   "properties": {
     "a": {
       "type": [

diff --git a/crates/schema-inference/src/snapshots/schema_inference__analyze__test__very_nested.snap b/crates/schema-inference/src/snapshots/schema_inference__analyze__test__very_nested.snap
@@ -6,59 +6,36 @@ expression: schema
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
-  "required": [
-    "a",
-    "one"
-  ],
   "properties": {
     "a": {
       "type": "boolean"
     },
     "one": {
       "type": "object",
-      "required": [
-        "b",
-        "two"
-      ],
       "properties": {
         "b": {
           "type": "integer"
         },
         "two": {
           "type": "object",
-          "required": [
-            "c",
-            "three"
-          ],
           "properties": {
             "c": {
               "type": "number"
             },
             "three": {
               "type": "object",
-              "required": [
-                "d",
-                "four"
-              ],
               "properties": {
                 "d": {
                   "type": "null"
                 },
                 "four": {
                   "type": "object",
-                  "required": [
-                    "e",
-                    "five"
-                  ],
                   "properties": {
                     "e": {
                       "type": "boolean"
                     },
                     "five": {
                       "type": "object",
-                      "required": [
-                        "f"
-                      ],
                       "properties": {
                         "f": {
                           "type": "string"