fix: fixed issues with navigating with jsonpointers through unknown properties

Author: TristanSpeakEasy

jsonpointer/jsonpointer.go

@@ -313,6 +313,23 @@ func getKeyBasedStructTarget(sourceVal reflect.Value, currentPart navigationPart
 		}
 	}
 
+	// Field not found in struct fields, try searching the associated YAML node if available
+	// Check if the struct implements RootNodeAccessor interface (which has GetRootNode)
+	type rootNodeAccessor interface {
+		GetRootNode() *yaml.Node
+	}
+
+	if rootNodeAccessor, ok := sourceVal.Interface().(rootNodeAccessor); ok {
+		rootNode := rootNodeAccessor.GetRootNode()
+		if rootNode != nil {
+			// Use the existing YAML node navigation logic to search for the key
+			result, newStack, err := getYamlNodeTarget(rootNode, currentPart, stack, currentPath, o)
+			if err == nil {
+				return result, newStack, nil
+			}
+		}
+	}
+
 	return nil, nil, ErrNotFound.Wrap(fmt.Errorf("key %s not found in %v at %s", key, sourceVal.Type(), currentPath))
 }
 

jsonpointer/models.go

@@ -107,9 +107,9 @@ func navigateModel(sourceVal reflect.Value, currentPart navigationPart, stack []
 
 	if coreFieldIndex == -1 {
 		// Field not found in core model, try searching the associated YAML node
-		// Check if the model implements CoreModeler interface (which has GetRootNode)
-		if coreModeler, ok := coreAny.(marshaller.CoreModeler); ok {
-			rootNode := coreModeler.GetRootNode()
+		// Check if the high-level model implements RootNodeAccessor interface (which has GetRootNode)
+		if rootNodeAccessor, ok := sourceVal.Interface().(marshaller.RootNodeAccessor); ok {
+			rootNode := rootNodeAccessor.GetRootNode()
 			if rootNode != nil {
 				// Use the existing YAML node navigation logic to search for the key
 				result, newStack, err := getYamlNodeTarget(rootNode, currentPart, stack, currentPath, o)

jsonpointer/models_yaml_fallback_test.go

@@ -195,3 +195,50 @@ func getTypeName(v interface{}) string {
 	}
 	return reflect.TypeOf(v).String()
 }
+
+// TestNavigateModel_YAMLFallback_KeyBasedStruct tests we can access the RootNode from Key based structs like our core models
+// This validates the fix where GetTarget can navigate from a core model to additional YAML properties
+func TestNavigateModel_YAMLFallback_KeyBasedStruct(t *testing.T) {
+	t.Parallel()
+
+	yamlContent := `
+knownField: "test"
+definitions:
+  attachments:
+    title: Attachments
+    description: "Array of attachments"
+    type: array
+    items:
+      type: object
+`
+
+	// Parse YAML content
+	var rootNode yaml.Node
+	err := yaml.Unmarshal([]byte(yamlContent), &rootNode)
+	require.NoError(t, err, "failed to parse YAML")
+
+	// Create test model with YAML node
+	model := &TestModel{}
+	model.GetCore().SetRootNode(&rootNode)
+
+	// Test navigation from the CORE MODEL (this was the bug - GetTarget couldn't find YAML properties from core model)
+	coreModel := model.GetCore()
+
+	// Test navigation to definitions key (not in core model)
+	result, err := GetTarget(coreModel, "/definitions")
+	require.NoError(t, err, "should find definitions in YAML from core model")
+	require.NotNil(t, result, "result should not be nil")
+
+	yamlNode, ok := result.(*yaml.Node)
+	require.True(t, ok, "should return yaml.Node for definitions")
+	assert.Equal(t, yaml.MappingNode, yamlNode.Kind, "definitions should be a mapping node")
+
+	// Test navigation deeper into definitions structure from core model
+	result, err = GetTarget(coreModel, "/definitions/attachments/title")
+	require.NoError(t, err, "should navigate through YAML structure from core model")
+	require.NotNil(t, result, "result should not be nil")
+
+	yamlNode, ok = result.(*yaml.Node)
+	require.True(t, ok, "should return yaml.Node")
+	assert.Equal(t, "Attachments", yamlNode.Value, "title value should match")
+}

jsonschema/oas3/validation.go

@@ -145,8 +145,7 @@ func getRootCauses(err *jsValidator.ValidationError, js core.Schema) []error {
 
 			t, err := jsonpointer.GetTarget(js, errJP, jsonpointer.WithStructTags("key"))
 			if err != nil {
-				// TODO need to potentially handle this in another way
-				errs = append(errs, err)
+				errs = append(errs, validation.NewValidationError(err, js.GetRootNode()))
 				continue
 			}