References under paths are compared only by ref name - oasdiff should compare the ref values.

[reuvenharrison]

Describe the bug
When a Path Item Object contains a $ref, oasdiff compares only textual changes to the $ref field.
Ideally, oasdiff should compare the referenced definitions of this path item(s) to each-other.

To Reproduce
Steps to reproduce the behavior:
Run oasdiff -base ref1.yaml -revision ref2.yaml

ref1.yaml

openapi: 3.0.1
info:
  title: Test API
  version: v1
paths:
  /partner-api/test/some-method:
    $ref: '#/components/paths/path1'
components:
  paths:
    path1:
      get:
        responses:
          "200":
            description: Success

ref2.yaml

openapi: 3.0.1
info:
  title: Test API
  version: v1
paths:
  /partner-api/test/some-method:
    $ref: '#/components/paths/path2'
components:
  paths:
    path2:
      get:
        responses:
          "200":
            description: Success

Result:

paths:
    modified:
        /partner-api/test/some-method:
            ref:
                from: '#/components/paths/path1'
                to: '#/components/paths/path2'

[wtrocki]

I'm happy to work on this issue.

[wtrocki]

@reuvenharrison I had some attempts to fix this by creating new diff category:

// RefDiff describes the changes between content refs
type RefDiff struct {
	RefModifled []string `json:"refModified,omitempty" yaml:"refModified,omitempty"`
}

type RequestBodyDiff struct {
        ... 
	RefDiff			*RefDiff     	    `json:"ref,omitempty" yaml:"ref,omitempty"`
}

Do you think this is the good way to approach this problem?

I noticed we also have RefDiff *ValueDiff in PathDiff object.

[wtrocki]

Going to use RefDiff *ValueDif