fix: Fix IndexError if a schema has an applicator keyword at top-level

jpmckinney · jpmckinney · commit 6a766b628249 · 2026-03-24T11:05:35.000-04:00
diff --git a/ocdskit/commands/normalize.py b/ocdskit/commands/normalize.py
@@ -73,7 +73,7 @@ def handle(self):
             remove_fields=set(self.args.ignore_fields),
         )
 
-        # Get valid JSON Schema, and reduce its size.
+        # Get valid JSON Schema, and reduce its size. NOTE: These operations can in principle be a separate command.
         if schema.get("openapi", "").startswith("3.0"):
             schema = convert_from_oas3(schema, get_only=self.args.get_only)
         if self.args.remove_private_fields:
diff --git a/ocdskit/normalize.py b/ocdskit/normalize.py
@@ -328,7 +328,7 @@ def _hoist(value, key, parent, definition=None, definition_name=None, prop=""):
                 if not name:
                     name = value.get("title")
                     if not name:  # don't use default argument to `get` in case prop is empty
-                        name = prop[0].upper() + prop[1:]
+                        name = prop[0].upper() + prop[1:] if prop else definition_name
                     if name in definitions:
                         name = f"{name}_{format(hashed & 0xFFFFFFFF, '08x')}"
                     definitions[name] = value
@@ -338,7 +338,7 @@ def _hoist(value, key, parent, definition=None, definition_name=None, prop=""):
                 # Recalculate the current definition's hash.
                 if definition is not None:
                     hashes[hasher(definition)] = definition_name
-            # Special case for allOf inheritance (note the `definition` argument). Avoids IndexError when naming.
+            # Special case for allOf inheritance (note the `definition` argument).
             if value is definition and "allOf" in value and len(value) == 1:
                 for i, v in enumerate(definition["allOf"]):
                     _hoist(v, i, value["allOf"], v, definition_name, prop)
@@ -359,7 +359,7 @@ def _hoist(value, key, parent, definition=None, definition_name=None, prop=""):
 
     schema.pop(definition_keyword)  # avoid re-processing definitions
     for key, value in schema.items():
-        _hoist(value, key, schema)
+        _hoist(value, key, schema, definition_name="Root")
     schema[definition_keyword] = definitions
 
 
diff --git a/tests/test_normalize.py b/tests/test_normalize.py
@@ -238,6 +238,27 @@ def test_get_normal_schema_list_traversal():
     assert result == [{"type": "string"}, {"type": "integer"}]
 
 
+def test_hoist_deep_properties_list_traversal():
+    schema = {
+        "definitions": {
+            "Root": {
+                "anyOf": [
+                    {"title": "Child", "type": "object", "properties": {"x": {"type": "string"}}},
+                    {"type": "null"},
+                ]
+            }
+        }
+    }
+    hoist_deep_properties(schema, lambda s: s)
+
+    assert schema == {
+        "definitions": {
+            "Root": {"anyOf": [{"$ref": "#/definitions/Child"}, {"type": "null"}]},
+            "Child": {"title": "Child", "type": "object", "properties": {"x": {"type": "string"}}},
+        }
+    }
+
+
 @pytest.mark.parametrize("keyword", ["definitions", "$defs"])
 def test_hoist_deep_properties_named_by_title(keyword):
     schema = {
@@ -280,19 +301,19 @@ def test_hoist_deep_properties_named_by_prop():
 def test_hoist_deep_properties_name_collision():
     schema = {
         "definitions": {
-            "Child": {"type": "string"},  # name already taken
             "Root": {
                 "type": "object",
                 "properties": {"child": {"type": "object", "properties": {"x": {"type": "string"}}}},
             },
+            "Child": {"type": "string"},  # name already taken
         }
     }
     hoist_deep_properties(schema, lambda s: s)
 
     assert schema == {
         "definitions": {
-            "Child": {"type": "string"},
             "Root": {"type": "object", "properties": {"child": {"$ref": "#/definitions/Child_c018a9ca"}}},
+            "Child": {"type": "string"},
             "Child_c018a9ca": {"type": "object", "properties": {"x": {"type": "string"}}},
         }
     }
@@ -302,7 +323,29 @@ def test_hoist_deep_properties_top_level_definition():
     schema = {"definitions": {"Flat": {"type": "object", "properties": {"x": {"type": "string"}}}}}
     hoist_deep_properties(schema, lambda s: s)
 
-    assert schema == {"definitions": {"Flat": {"type": "object", "properties": {"x": {"type": "string"}}}}}
+    assert schema == {
+        "definitions": {"Flat": {"type": "object", "properties": {"x": {"type": "string"}}}},
+    }
+
+
+def test_hoist_deep_properties_top_level_properties():
+    schema = {"properties": {"top": {"type": "object", "properties": {"x": {"type": "string"}}}}}
+    hoist_deep_properties(schema, lambda s: s)
+
+    assert schema == {
+        "properties": {"top": {"$ref": "#/$defs/Top"}},
+        "$defs": {"Top": {"type": "object", "properties": {"x": {"type": "string"}}}},
+    }
+
+
+def test_hoist_deep_properties_top_level_applicator():
+    schema = {"anyOf": [{"type": "object", "properties": {"x": {"type": "string"}}}]}
+    hoist_deep_properties(schema, lambda s: s)
+
+    assert schema == {
+        "anyOf": [{"$ref": "#/$defs/Root"}],
+        "$defs": {"Root": {"type": "object", "properties": {"x": {"type": "string"}}}},
+    }
 
 
 def test_hoist_deep_properties_allof_special_case():
@@ -328,22 +371,34 @@ def test_hoist_deep_properties_allof_special_case():
     }
 
 
-def test_hoist_deep_properties_top_level_properties():
-    schema = {"properties": {"foo": {"type": "object", "properties": {"x": {"type": "string"}}}}}
+def test_hoist_deep_properties_applicator_allof():
+    schema = {
+        "definitions": {
+            "Root": {
+                "allOf": [{"type": "object", "properties": {"x": {"type": "string"}}}],
+                "description": "x",
+            }
+        }
+    }
     hoist_deep_properties(schema, lambda s: s)
 
     assert schema == {
-        "properties": {"foo": {"$ref": "#/$defs/Foo"}},
-        "$defs": {"Foo": {"type": "object", "properties": {"x": {"type": "string"}}}},
+        "definitions": {
+            "Root": {
+                "allOf": [{"$ref": "#/definitions/Root_c018a9ca"}],
+                "description": "x",
+            },
+            "Root_c018a9ca": {"type": "object", "properties": {"x": {"type": "string"}}},
+        }
     }
 
 
-def test_hoist_deep_properties_list_traversal():
+def test_hoist_deep_properties_applicator_anyof():
     schema = {
         "definitions": {
             "Root": {
                 "anyOf": [
-                    {"title": "Child", "type": "object", "properties": {"x": {"type": "string"}}},
+                    {"type": "object", "properties": {"x": {"type": "string"}}},
                     {"type": "null"},
                 ]
             }
@@ -353,8 +408,8 @@ def test_hoist_deep_properties_list_traversal():
 
     assert schema == {
         "definitions": {
-            "Root": {"anyOf": [{"$ref": "#/definitions/Child"}, {"type": "null"}]},
-            "Child": {"title": "Child", "type": "object", "properties": {"x": {"type": "string"}}},
+            "Root": {"anyOf": [{"$ref": "#/definitions/Root_c018a9ca"}, {"type": "null"}]},
+            "Root_c018a9ca": {"type": "object", "properties": {"x": {"type": "string"}}},
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ def handle(self):`
`73`	`73`	`remove_fields=set(self.args.ignore_fields),`
`74`	`74`	`)`
`75`	`75`
`76`		`- # Get valid JSON Schema, and reduce its size.`
	`76`	`+ # Get valid JSON Schema, and reduce its size. NOTE: These operations can in principle be a separate command.`
`77`	`77`	`if schema.get("openapi", "").startswith("3.0"):`
`78`	`78`	`schema = convert_from_oas3(schema, get_only=self.args.get_only)`
`79`	`79`	`if self.args.remove_private_fields:`