openapi3: record block end on Origin.Key (EndLine/EndColumn) (getkin#1207)

Author: reuvenharrison

.github/docs/openapi3.txt

@@ -1373,6 +1373,13 @@ type Location struct {
 	Line   int    `json:"line,omitempty" yaml:"line,omitempty"`
 	Column int    `json:"column,omitempty" yaml:"column,omitempty"`
 	Name   string `json:"name,omitempty" yaml:"name,omitempty"`
+
+	// EndLine and EndColumn mark the end of the block this location heads (set
+	// only on Origin.Key). For an operation or schema this spans the whole
+	// block, so a consumer can extract the entire element from its source.
+	// Both are zero when the underlying YAML carried no end information.
+	EndLine   int `json:"endLine,omitempty" yaml:"endLine,omitempty"`
+	EndColumn int `json:"endColumn,omitempty" yaml:"endColumn,omitempty"`
 }
     Location is a struct that contains the location of a field.
 

go.mod

@@ -5,8 +5,8 @@ go 1.25
 require (
 	github.com/go-openapi/jsonpointer v0.22.5
 	github.com/gorilla/mux v1.8.0
-	github.com/oasdiff/yaml v0.1.0
-	github.com/oasdiff/yaml3 v0.0.13
+	github.com/oasdiff/yaml v0.1.1
+	github.com/oasdiff/yaml3 v0.0.14
 	github.com/santhosh-tekuri/jsonschema/v6 v6.0.2
 	github.com/stretchr/testify v1.9.0
 )

go.sum

@@ -17,10 +17,10 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/oasdiff/yaml v0.1.0 h1:0bqZjfKc/8S9urj4JuwepX41WX9EoA6ifhU3SV06cXg=
-github.com/oasdiff/yaml v0.1.0/go.mod h1:kOlRmMdL2X3vucLCEQO5u61SU22RysnfXvcttrZA1O0=
-github.com/oasdiff/yaml3 v0.0.13 h1:06svmvOHOVBqF81+sY2EUScvUI/iS/vl2VIeUUxZQwg=
-github.com/oasdiff/yaml3 v0.0.13/go.mod h1:y5+oSEHCPT/DGrS++Wc/479ERge0zTFxaF8PbGKcg2o=
+github.com/oasdiff/yaml v0.1.1 h1:6nHx+pn9gBRM6YpBlFZFQGCCd1nuvqOBtTD3KKTgGxY=
+github.com/oasdiff/yaml v0.1.1/go.mod h1:EYJNoyktvWMJ0Hmhx+6qTaqMOsalUaRGT8Sj1hNcegU=
+github.com/oasdiff/yaml3 v0.0.14 h1:aLJee3hxBK2H5wdXd9iPcIXb93Nty1Ge0pT171eHtkw=
+github.com/oasdiff/yaml3 v0.0.14/go.mod h1:csto2xfDjYccdUn/yw/bPjj/cYTdp6HtFA0J4TWG+gg=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ=

openapi3/origin.go

@@ -27,6 +27,13 @@ type Location struct {
 	Line   int    `json:"line,omitempty" yaml:"line,omitempty"`
 	Column int    `json:"column,omitempty" yaml:"column,omitempty"`
 	Name   string `json:"name,omitempty" yaml:"name,omitempty"`
+
+	// EndLine and EndColumn mark the end of the block this location heads (set
+	// only on Origin.Key). For an operation or schema this spans the whole
+	// block, so a consumer can extract the entire element from its source.
+	// Both are zero when the underlying YAML carried no end information.
+	EndLine   int `json:"endLine,omitempty" yaml:"endLine,omitempty"`
+	EndColumn int `json:"endColumn,omitempty" yaml:"endColumn,omitempty"`
 }
 
 // originFromSeq parses the compact []any sequence produced by yaml3's addOrigin.
@@ -99,6 +106,17 @@ func originFromSeq(s []any) *Origin {
 			o.Sequences[sname] = locs
 		}
 	}
+
+	// Trailing block end (yaml3 >= the end-position release): end_delta, end_col.
+	// Reconstruct the end of the whole block on Origin.Key so a consumer can
+	// extract the entire element. Older origin sequences omit these, leaving
+	// EndLine/EndColumn zero. end_col == 0 means no end information was recorded.
+	if o.Key != nil && idx+1 < len(s) {
+		if endCol := toInt(s[idx+1]); endCol > 0 {
+			o.Key.EndLine = keyLine + toInt(s[idx])
+			o.Key.EndColumn = endCol
+		}
+	}
 	return o
 }