fix: respect definitions for all when inlining nullable references (#417

)
victools · Nov 23, 2023 · 1aced59 · 1aced59
1 parent ea90e6c
commit 1aced59
Show file tree

Hide file tree

Showing 12 changed files with 415 additions and 180 deletions.
diff --git a/...chema-generator/src/main/java/com/github/victools/jsonschema/generator/SchemaBuilder.java b/...chema-generator/src/main/java/com/github/victools/jsonschema/generator/SchemaBuilder.java
@@ -300,15 +300,14 @@ private Predicate<DefinitionKey> getShouldProduceDefinitionCheck(DefinitionKey m
                 // global setting: always inline schemas by default
                 return false;
             }
-            if (definitionKey.equals(mainSchemaKey)) {
+            if (createDefinitionsForAll || definitionKey.equals(mainSchemaKey)) {
                 return true;
             }
             List<ObjectNode> references = this.generationContext.getReferences(definitionKey);
             if (considerOnlyDirectReferences.get() && references.isEmpty()) {
                 return false;
             }
-            return createDefinitionsForAll
-                    || references.size() > 1
+            return references.size() > 1
                     || (references.size() + this.generationContext.getNullableReferences(definitionKey).size()) > 1;
         };
     }

diff --git a/...es/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_2019_09.json b/...es/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_2019_09.json
@@ -1,28 +1,46 @@
 {
     "$defs": {
+        "List(TestCircularClass1)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#"
+                }
+            }
+        },
+        "List(TestCircularClass2)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#/$defs/TestCircularClass2"
+                }
+            }
+        },
         "TestCircularClass2": {
             "type": "object",
             "properties": {
                 "list1": {
-                    "type": ["object", "null"],
-                    "properties": {
-                        "get(0)": {
-                            "$ref": "#"
+                    "anyOf": [
+                        {
+                            "type": "null"
+                        }, {
+                            "$ref": "#/$defs/List(TestCircularClass1)"
                         }
-                    }
+                    ]
                 }
             }
         }
     },
     "type": "object",
     "properties": {
         "list2": {
-            "type": ["object", "null"],
-            "properties": {
-                "get(0)": {
-                    "$ref": "#/$defs/TestCircularClass2"
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/$defs/List(TestCircularClass2)"
                 }
-            }
+            ]
         }
     }
 }
diff --git a/...es/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_2020_12.json b/...es/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_2020_12.json
@@ -1,28 +1,46 @@
 {
     "$defs": {
+        "List(TestCircularClass1)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#"
+                }
+            }
+        },
+        "List(TestCircularClass2)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#/$defs/TestCircularClass2"
+                }
+            }
+        },
         "TestCircularClass2": {
             "type": "object",
             "properties": {
                 "list1": {
-                    "type": ["object", "null"],
-                    "properties": {
-                        "get(0)": {
-                            "$ref": "#"
+                    "anyOf": [
+                        {
+                            "type": "null"
+                        }, {
+                            "$ref": "#/$defs/List(TestCircularClass1)"
                         }
-                    }
+                    ]
                 }
             }
         }
     },
     "type": "object",
     "properties": {
         "list2": {
-            "type": ["object", "null"],
-            "properties": {
-                "get(0)": {
-                    "$ref": "#/$defs/TestCircularClass2"
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/$defs/List(TestCircularClass2)"
                 }
-            }
+            ]
         }
     }
 }
diff --git a/...esources/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_6.json b/...esources/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_6.json
@@ -1,28 +1,46 @@
 {
     "definitions": {
+        "List(TestCircularClass1)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#"
+                }
+            }
+        },
+        "List(TestCircularClass2)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#/definitions/TestCircularClass2"
+                }
+            }
+        },
         "TestCircularClass2": {
             "type": "object",
             "properties": {
                 "list1": {
-                    "type": ["object", "null"],
-                    "properties": {
-                        "get(0)": {
-                            "$ref": "#"
+                    "anyOf": [
+                        {
+                            "type": "null"
+                        }, {
+                            "$ref": "#/definitions/List(TestCircularClass1)"
                         }
-                    }
+                    ]
                 }
             }
         }
     },
     "type": "object",
     "properties": {
         "list2": {
-            "type": ["object", "null"],
-            "properties": {
-                "get(0)": {
-                    "$ref": "#/definitions/TestCircularClass2"
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/definitions/List(TestCircularClass2)"
                 }
-            }
+            ]
         }
     }
 }
diff --git a/...esources/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_7.json b/...esources/com/github/victools/jsonschema/generator/circular-custom-definition-DRAFT_7.json
@@ -1,28 +1,46 @@
 {
     "definitions": {
+        "List(TestCircularClass1)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#"
+                }
+            }
+        },
+        "List(TestCircularClass2)": {
+            "type": "object",
+            "properties": {
+                "get(0)": {
+                    "$ref": "#/definitions/TestCircularClass2"
+                }
+            }
+        },
         "TestCircularClass2": {
             "type": "object",
             "properties": {
                 "list1": {
-                    "type": ["object", "null"],
-                    "properties": {
-                        "get(0)": {
-                            "$ref": "#"
+                    "anyOf": [
+                        {
+                            "type": "null"
+                        }, {
+                            "$ref": "#/definitions/List(TestCircularClass1)"
                         }
-                    }
+                    ]
                 }
             }
         }
     },
     "type": "object",
     "properties": {
         "list2": {
-            "type": ["object", "null"],
-            "properties": {
-                "get(0)": {
-                    "$ref": "#/definitions/TestCircularClass2"
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/definitions/List(TestCircularClass2)"
                 }
-            }
+            ]
         }
     }
 }
diff --git a/...m/github/victools/jsonschema/generator/testclass-withsupertypereferences-NO_SUBTYPES.json b/...m/github/victools/jsonschema/generator/testclass-withsupertypereferences-NO_SUBTYPES.json
@@ -1,8 +1,8 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "definitions": {
-        "TestSuperClass(Boolean)-nullable": {
-            "type": ["object", "null"],
+        "TestSuperClass(Boolean)": {
+            "type": "object",
             "properties": {
                 "genericFieldInSupertype": {
                     "type": ["boolean", "null"],
@@ -12,8 +12,17 @@
             "title": "TestSuperClass<Boolean>",
             "description": "supertype-only description"
         },
-        "TestSuperClass(String)-nullable": {
-            "type": ["object", "null"],
+        "TestSuperClass(Boolean)-nullable": {
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/definitions/TestSuperClass(Boolean)"
+                }
+            ]
+        },
+        "TestSuperClass(String)": {
+            "type": "object",
             "properties": {
                 "genericFieldInSupertype": {
                     "type": ["string", "null"],
@@ -22,6 +31,15 @@
             },
             "title": "TestSuperClass<String>",
             "description": "supertype-only description"
+        },
+        "TestSuperClass(String)-nullable": {
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/definitions/TestSuperClass(String)"
+                }
+            ]
         }
     },
     "type": "object",

diff --git a/.../victools/jsonschema/generator/testclass-withsupertypereferences-ONE_SUBTYPE_INVALID.json b/.../victools/jsonschema/generator/testclass-withsupertypereferences-ONE_SUBTYPE_INVALID.json
@@ -15,8 +15,8 @@
             },
             "title": "TestSubClass3"
         },
-        "TestSuperClass(Boolean)-nullable": {
-            "type": ["object", "null"],
+        "TestSuperClass(Boolean)": {
+            "type": "object",
             "properties": {
                 "genericFieldInSupertype": {
                     "type": ["boolean", "null"],
@@ -26,12 +26,26 @@
             "title": "TestSuperClass<Boolean>",
             "description": "supertype-only description"
         },
+        "TestSuperClass(Boolean)-nullable": {
+            "anyOf": [
+                {
+                    "type": "null"
+                }, {
+                    "$ref": "#/definitions/TestSuperClass(Boolean)"
+                }
+            ]
+        },
+        "TestSuperClass(String)": {
+            "$ref": "#/definitions/TestSubClass3"
+        },
         "TestSuperClass(String)-nullable": {
-            "anyOf": [{
+            "anyOf": [
+                {
                     "type": "null"
                 }, {
-                    "$ref": "#/definitions/TestSubClass3"
-                }]
+                    "$ref": "#/definitions/TestSuperClass(String)"
+                }
+            ]
         }
     },
     "type": "object",
@@ -40,15 +54,17 @@
             "$ref": "#/definitions/TestSuperClass(Boolean)-nullable"
         },
         "numberOrStringObjectField": {
-            "anyOf": [{
+            "anyOf": [
+                {
                     "type": "null"
                 }, {
                     "type": "number",
                     "title": "Number"
                 }, {
                     "type": "string",
                     "title": "String"
-                }]
+                }
+            ]
         },
         "stringSupertypeField": {
             "$ref": "#/definitions/TestSuperClass(String)-nullable"