LukeParke/libopenapi
1
0
Fork 0
mirror of https://github.com/LukeHagar/libopenapi.git synced 2025-12-06 12:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

first level testing for rending v3 model in place.

Browse Source 
Now onto some hardening tests, lets re-render each spec after reading to check for failures.
This commit is contained in:
Dave Shanley
2023-03-14 06:35:00 -04:00
parent 162d62a229
commit 5d7f22fca7
25 changed files with 417 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
datamodel/high/base/contact.go
View File

@@ -44,9 +44,6 @@ func (c *Contact) Render() ([]byte, error) {
}
func (c *Contact) MarshalYAML() (interface{}, error) {
if c == nil {
return nil, nil
}
nb := high.NewNodeBuilder(c, c.low)
return nb.Render(), nil
}

3
datamodel/high/base/discriminator.go
View File

@@ -53,9 +53,6 @@ func (d *Discriminator) Render() ([]byte, error) {
// MarshalYAML will create a ready to render YAML representation of the Discriminator object.
func (d *Discriminator) MarshalYAML() (interface{}, error) {
if d == nil {
return nil, nil
}
nb := high.NewNodeBuilder(d, d.low)
return nb.Render(), nil
}

3
datamodel/high/base/external_doc.go
View File

@@ -56,9 +56,6 @@ func (e *ExternalDoc) Render() ([]byte, error) {
// MarshalYAML will create a ready to render YAML representation of the ExternalDoc object.
func (e *ExternalDoc) MarshalYAML() (interface{}, error) {
if e == nil {
return nil, nil
}
nb := high.NewNodeBuilder(e, e.low)
return nb.Render(), nil
}

3
datamodel/high/base/info.go
View File

@@ -76,9 +76,6 @@ func (i *Info) Render() ([]byte, error) {
// MarshalYAML will create a ready to render YAML representation of the Info object.
func (i *Info) MarshalYAML() (interface{}, error) {
if i == nil {
return nil, nil
}
nb := high.NewNodeBuilder(i, i.low)
return nb.Render(), nil
}

3
datamodel/high/base/license.go
View File

@@ -48,9 +48,6 @@ func (l *License) Render() ([]byte, error) {
// MarshalYAML will create a ready to render YAML representation of the License object.
func (l *License) MarshalYAML() (interface{}, error) {
if l == nil {
return nil, nil
}
nb := high.NewNodeBuilder(l, l.low)
return nb.Render(), nil
}

23
datamodel/high/base/schema_proxy.go
View File

@@ -46,6 +46,7 @@ import (
type SchemaProxy struct {
schema *low.NodeReference[*base.SchemaProxy]
buildError error
rendered *Schema
}
// NewSchemaProxy creates a new high-level SchemaProxy from a low-level one.
@@ -57,14 +58,19 @@ func NewSchemaProxy(schema *low.NodeReference[*base.SchemaProxy]) *SchemaProxy {
// If there is a problem building the Schema, then this method will return nil. Use GetBuildError to gain access
// to that building error.
func (sp *SchemaProxy) Schema() *Schema {
s := sp.schema.Value.Schema()
if s == nil {
sp.buildError = sp.schema.Value.GetBuildError()
return nil
if sp.rendered == nil {
s := sp.schema.Value.Schema()
if s == nil {
sp.buildError = sp.schema.Value.GetBuildError()
return nil
}
sch := NewSchema(s)
sch.ParentProxy = sp
sp.rendered = sch
return sch
} else {
return sp.rendered
}
sch := NewSchema(s)
sch.ParentProxy = sp
return sch
}
// IsReference returns true if the SchemaProxy is a reference to another Schema.
@@ -79,6 +85,9 @@ func (sp *SchemaProxy) GetReference() string {
// BuildSchema operates the same way as Schema, except it will return any error along with the *Schema
func (sp *SchemaProxy) BuildSchema() (*Schema, error) {
if sp.rendered != nil {
return sp.rendered, sp.buildError
}
schema := sp.Schema()
er := sp.buildError
return schema, er

3
datamodel/high/base/tag.go
View File

@@ -57,9 +57,6 @@ func (t *Tag) Render() ([]byte, error) {
// MarshalYAML will create a ready to render YAML representation of the Info object.
func (t *Tag) MarshalYAML() (interface{}, error) {
if t == nil {
return nil, nil
}
nb := high.NewNodeBuilder(t, t.low)
return nb.Render(), nil
}

3
datamodel/high/base/xml.go
View File

@@ -58,9 +58,6 @@ func (x *XML) Render() ([]byte, error) {
// MarshalYAML will create a ready to render YAML representation of the XML object.
func (x *XML) MarshalYAML() (interface{}, error) {
if x == nil {
return nil, nil
}
nb := high.NewNodeBuilder(x, x.low)
return nb.Render(), nil
}

88
datamodel/high/node_builder.go
View File

@@ -59,12 +59,12 @@ func (n *NodeBuilder) add(key string) {
// and add them to the node builder.
if key == "Extensions" {
extensions := reflect.ValueOf(n.High).Elem().FieldByName(key)
for _, e := range extensions.MapKeys() {
for b, e := range extensions.MapKeys() {
v := extensions.MapIndex(e)
extKey := e.String()
extValue := v.Interface()
nodeEntry := &NodeEntry{Tag: extKey, Key: extKey, Value: extValue}
nodeEntry := &NodeEntry{Tag: extKey, Key: extKey, Value: extValue, Line: 9999 + b}
if !reflect.ValueOf(n.Low).IsZero() {
fieldValue := reflect.ValueOf(n.Low).Elem().FieldByName("Extensions")
@@ -199,19 +199,31 @@ func (n *NodeBuilder) Render() *yaml.Node {
// order nodes by line number, retain original order
m := CreateEmptyMapNode()
if fg, ok := n.Low.(low.IsReferenced); ok {
if fg.IsReference() {
m.Content = append(m.Content, n.renderReference()...)
return m
g := reflect.ValueOf(fg)
if !g.IsNil() {
if fg.IsReference() {
m.Content = append(m.Content, n.renderReference()...)
return m
}
}
}
sort.Slice(n.Nodes, func(i, j int) bool {
return n.Nodes[i].Line < n.Nodes[j].Line
if n.Nodes[i].Line != n.Nodes[j].Line {
return n.Nodes[i].Line < n.Nodes[j].Line
}
if strings.HasPrefix(n.Nodes[i].Key, "x-") {
return false
}
if strings.HasPrefix(n.Nodes[j].Key, "x-") {
return false
}
return false
})
for i := range n.Nodes {
node := n.Nodes[i]
n.AddYAMLNode(m, node.Tag, node.Key, node.Value)
n.AddYAMLNode(m, node.Tag, node.Key, node.Value, node.Line)
}
if len(m.Content) > 0 {
return m
@@ -222,7 +234,7 @@ func (n *NodeBuilder) Render() *yaml.Node {
// AddYAMLNode will add a new *yaml.Node to the parent node, using the tag, key and value provided.
// If the value is nil, then the node will not be added. This method is recursive, so it will dig down
// into any non-scalar types.
func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any) *yaml.Node {
func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any, line int) *yaml.Node {
if value == nil {
return parent
}
@@ -243,6 +255,7 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
return parent
}
valueNode = CreateStringNode(val)
valueNode.Line = line
break
case reflect.Bool:
@@ -251,12 +264,14 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
return parent
}
valueNode = CreateBoolNode("true")
valueNode.Line = line
break
case reflect.Int:
if value != nil {
val := strconv.Itoa(value.(int))
valueNode = CreateIntNode(val)
valueNode.Line = line
} else {
return parent
}
@@ -266,6 +281,7 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
if value != nil {
val := strconv.FormatInt(value.(int64), 10)
valueNode = CreateIntNode(val)
valueNode.Line = line
} else {
return parent
}
@@ -275,6 +291,7 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
if value != nil {
val := strconv.FormatFloat(value.(float64), 'f', 2, 64)
valueNode = CreateFloatNode(val)
valueNode.Line = line
} else {
return parent
}
@@ -389,6 +406,17 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
// sort the slice by line number to ensure everything is rendered in order.
sort.Slice(orderedCollection, func(i, j int) bool {
if orderedCollection[i].Line != orderedCollection[j].Line {
return orderedCollection[i].Line < orderedCollection[j].Line
}
if strings.HasPrefix(orderedCollection[i].Tag, "x-") {
return false
}
if strings.HasPrefix(orderedCollection[i].Tag, "x-") {
return false
}
return orderedCollection[i].Line < orderedCollection[j].Line
})
@@ -398,7 +426,7 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
// build out each map node in original order.
for _, cv := range orderedCollection {
n.AddYAMLNode(p, cv.Tag, cv.Key, cv.Value)
n.AddYAMLNode(p, cv.Tag, cv.Key, cv.Value, cv.Line)
}
if len(p.Content) > 0 {
valueNode = p
@@ -418,16 +446,23 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
sqi := m.Index(i).Interface()
if glu, ok := sqi.(GoesLowUntyped); ok {
if glu.GoLowUntyped().(low.IsReferenced).IsReference() {
ut := glu.GoLowUntyped()
rt := CreateEmptyMapNode()
if !reflect.ValueOf(ut).IsNil() {
nodes := make([]*yaml.Node, 2)
nodes[0] = CreateStringNode("$ref")
nodes[1] = CreateStringNode(glu.GoLowUntyped().(low.IsReferenced).GetReference())
rt.Content = append(rt.Content, nodes...)
sl.Content = append(sl.Content, rt)
r := ut.(low.IsReferenced)
if ut != nil && r.GetReference() != "" &&
ut.(low.IsReferenced).IsReference() {
rt := CreateEmptyMapNode()
nodes := make([]*yaml.Node, 2)
nodes[0] = CreateStringNode("$ref")
nodes[1] = CreateStringNode(glu.GoLowUntyped().(low.IsReferenced).GetReference())
rt.Content = append(rt.Content, nodes...)
sl.Content = append(sl.Content, rt)
}
}
}
@@ -459,12 +494,16 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
case reflect.Ptr:
if r, ok := value.(Renderable); ok {
if gl, lg := value.(GoesLowUntyped); lg {
if gl.GoLowUntyped().(low.IsReferenced).IsReference() {
rvn := CreateEmptyMapNode()
rvn.Content = append(rvn.Content, CreateStringNode("$ref"))
rvn.Content = append(rvn.Content, CreateStringNode(gl.GoLowUntyped().(low.IsReferenced).GetReference()))
valueNode = rvn
break
ut := reflect.ValueOf(gl.GoLowUntyped())
if !ut.IsNil() {
if gl.GoLowUntyped().(low.IsReferenced).IsReference() {
rvn := CreateEmptyMapNode()
rvn.Content = append(rvn.Content, CreateStringNode("$ref"))
rvn.Content = append(rvn.Content, CreateStringNode(gl.GoLowUntyped().(low.IsReferenced).GetReference()))
valueNode = rvn
break
}
}
}
rawRender, _ := r.MarshalYAML()
@@ -481,18 +520,21 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
encodeSkip = true
if *b {
valueNode = CreateBoolNode("true")
valueNode.Line = line
}
}
if b, bok := value.(*int64); bok {
encodeSkip = true
if *b > 0 {
valueNode = CreateIntNode(strconv.Itoa(int(*b)))
valueNode.Line = line
}
}
if b, bok := value.(*float64); bok {
encodeSkip = true
if *b > 0 {
valueNode = CreateFloatNode(strconv.FormatFloat(*b, 'f', -1, 64))
valueNode.Line = line
}
}
if !encodeSkip {
@@ -502,6 +544,7 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
return parent
} else {
valueNode = &rawNode
valueNode.Line = line
}
}
}
@@ -516,6 +559,7 @@ func (n *NodeBuilder) AddYAMLNode(parent *yaml.Node, tag, key string, value any)
return parent
} else {
valueNode = &rawNode
valueNode.Line = line
}
}
if valueNode == nil {

45
datamodel/high/v3/callback.go
View File

@@ -61,32 +61,51 @@ func (c *Callback) MarshalYAML() (interface{}, error) {
cb *PathItem
exp string
line int
ext *yaml.Node
}
var mapped []*cbItem
for k, ex := range c.Expression {
ln := 9999 // default to a high value to weight new content to the bottom.
ln := 999 // default to a high value to weight new content to the bottom.
if c.low != nil {
lcb := c.low.FindExpression(k)
if lcb != nil {
ln = lcb.ValueNode.Line
for lKey := range c.low.Expression.Value {
if lKey.Value == k {
ln = lKey.KeyNode.Line
}
}
}
mapped = append(mapped, &cbItem{ex, k, ln})
mapped = append(mapped, &cbItem{ex, k, ln, nil})
}
// extract extensions
nb := high.NewNodeBuilder(c, c.low)
extNode := nb.Render()
if extNode != nil && extNode.Content != nil {
var label string
for u := range extNode.Content {
if u%2 == 0 {
label = extNode.Content[u].Value
continue
}
mapped = append(mapped, &cbItem{nil, label,
extNode.Content[u].Line, extNode.Content[u]})
}
}
sort.Slice(mapped, func(i, j int) bool {
return mapped[i].line < mapped[j].line
})
for j := range mapped {
rendered, _ := mapped[j].cb.MarshalYAML()
m.Content = append(m.Content, high.CreateStringNode(mapped[j].exp))
m.Content = append(m.Content, rendered.(*yaml.Node))
}
nb := high.NewNodeBuilder(c, c.low)
extNode := nb.Render()
if extNode.Content != nil {
m.Content = append(m.Content, extNode.Content...)
if mapped[j].cb != nil {
rendered, _ := mapped[j].cb.MarshalYAML()
m.Content = append(m.Content, high.CreateStringNode(mapped[j].exp))
m.Content = append(m.Content, rendered.(*yaml.Node))
}
if mapped[j].ext != nil {
m.Content = append(m.Content, high.CreateStringNode(mapped[j].exp))
m.Content = append(m.Content, mapped[j].ext)
}
}
return m, nil
}

44
datamodel/high/v3/callback_test.go
View File

@@ -35,44 +35,28 @@ func TestCallback_MarshalYAML(t *testing.T) {
rend, _ := cb.Render()
desired := `https://pb33f.io:
get:
operationId: oneTwoThree
https://pb33f.io/libopenapi:
get:
operationId: openaypeeeye
x-burgers: why not?`
assert.Equal(t, desired, strings.TrimSpace(string(rend)))
// there is no way to determine order in brand new maps, so we have to check length.
assert.Len(t, rend, 152)
// mutate
cb.Expression["https://pb33f.io"].Get.OperationId = "blim-blam"
cb.Extensions = map[string]interface{}{"x-burgers": "yes please!"}
desired = `https://pb33f.io:
get:
operationId: blim-blam
https://pb33f.io/libopenapi:
get:
operationId: openaypeeeye
x-burgers: yes please!`
rend, _ = cb.Render()
assert.Equal(t, desired, strings.TrimSpace(string(rend)))
// there is no way to determine order in brand new maps, so we have to check length.
assert.Len(t, rend, 153)
k := `x-break-everything: please
"{$request.query.queryUrl}":
post:
requestBody: null
description: Callback payload
content:
application/json:
schema:
type: string
responses:
"200":
description: callback successfully processes
`
'{$request.query.queryUrl}':
post:
description: Callback payload
responses:
"200":
description: callback successfully processed
content:
application/json:
schema:
type: string`
var idxNode yaml.Node
err := yaml.Unmarshal([]byte(k), &idxNode)

4
datamodel/high/v3/components.go
View File

@@ -31,13 +31,9 @@ const (
// - https://spec.openapis.org/oas/v3.1.0#components-object
type Components struct {
Schemas map[string]*highbase.SchemaProxy `json:"schemas,omitempty" yaml:"schemas,omitempty"`
//Schemas map[string]*highbase.SchemaProxy `json:"-" yaml:"-"`
//Responses map[string]*Response `json:"-" yaml:"-"`
Responses map[string]*Response `json:"responses,omitempty" yaml:"responses,omitempty"`
//Parameters map[string]*Parameter `json:"-" yaml:"-"`
Parameters map[string]*Parameter `json:"parameters,omitempty" yaml:"parameters,omitempty"`
Examples map[string]*highbase.Example `json:"examples,omitempty" yaml:"examples,omitempty"`
//Examples map[string]*highbase.Example `json:"-" yaml:"-"`
RequestBodies map[string]*RequestBody `json:"requestBodies,omitempty" yaml:"requestBodies,omitempty"`
Headers map[string]*Header `json:"headers,omitempty" yaml:"headers,omitempty"`
SecuritySchemes map[string]*SecurityScheme `json:"securitySchemes,omitempty" yaml:"securitySchemes,omitempty"`

285
datamodel/high/v3/document_test.go
View File

@@ -4,10 +4,7 @@
package v3
import (
"fmt"
"io/ioutil"
"net/url"
"os"
"strings"
"testing"
@@ -159,7 +156,7 @@ func TestNewDocument_Components_Links(t *testing.T) {
assert.Equal(t, "$response.body#/id", h.Components.Links["LocateBurger"].Parameters["burgerId"])
wentLow := h.Components.Links["LocateBurger"].GoLow()
assert.Equal(t, 305, wentLow.OperationId.ValueNode.Line)
assert.Equal(t, 310, wentLow.OperationId.ValueNode.Line)
assert.Equal(t, 20, wentLow.OperationId.ValueNode.Column)
}
@@ -174,7 +171,7 @@ func TestNewDocument_Components_Callbacks(t *testing.T) {
)
assert.Equal(
t,
293,
298,
h.Components.Callbacks["BurgerCallback"].GoLow().FindExpression("{$request.query.queryUrl}").ValueNode.Line,
)
assert.Equal(
@@ -187,7 +184,7 @@ func TestNewDocument_Components_Callbacks(t *testing.T) {
for k := range h.Components.GoLow().Callbacks.Value {
if k.Value == "BurgerCallback" {
assert.Equal(t, 290, k.KeyNode.Line)
assert.Equal(t, 295, k.KeyNode.Line)
assert.Equal(t, 5, k.KeyNode.Column)
}
}
@@ -203,17 +200,17 @@ func TestNewDocument_Components_Schemas(t *testing.T) {
a := h.Components.Schemas["Error"]
abcd := a.Schema().Properties["message"].Schema().Example
assert.Equal(t, "No such burger as 'Big-Whopper'", abcd)
assert.Equal(t, 428, goLow.Schemas.KeyNode.Line)
assert.Equal(t, 433, goLow.Schemas.KeyNode.Line)
assert.Equal(t, 3, goLow.Schemas.KeyNode.Column)
assert.Equal(t, 431, a.Schema().GoLow().Description.KeyNode.Line)
assert.Equal(t, 436, a.Schema().GoLow().Description.KeyNode.Line)
b := h.Components.Schemas["Burger"]
assert.Len(t, b.Schema().Required, 2)
assert.Equal(t, "golden slices of happy fun joy", b.Schema().Properties["fries"].Schema().Description)
assert.Equal(t, int64(2), b.Schema().Properties["numPatties"].Schema().Example)
assert.Equal(t, 443, goLow.FindSchema("Burger").Value.Schema().Properties.KeyNode.Line)
assert.Equal(t, 448, goLow.FindSchema("Burger").Value.Schema().Properties.KeyNode.Line)
assert.Equal(t, 7, goLow.FindSchema("Burger").Value.Schema().Properties.KeyNode.Column)
assert.Equal(t, 445, b.Schema().GoLow().FindProperty("name").ValueNode.Line)
assert.Equal(t, 450, b.Schema().GoLow().FindProperty("name").ValueNode.Line)
f := h.Components.Schemas["Fries"]
assert.Equal(t, "salt", f.Schema().Properties["seasoning"].Schema().Items.A.Schema().Example)
@@ -224,12 +221,12 @@ func TestNewDocument_Components_Schemas(t *testing.T) {
assert.True(t, d.Schema().AdditionalProperties.(bool))
assert.Equal(t, "drinkType", d.Schema().Discriminator.PropertyName)
assert.Equal(t, "some value", d.Schema().Discriminator.Mapping["drink"])
assert.Equal(t, 511, d.Schema().Discriminator.GoLow().PropertyName.ValueNode.Line)
assert.Equal(t, 516, d.Schema().Discriminator.GoLow().PropertyName.ValueNode.Line)
assert.Equal(t, 23, d.Schema().Discriminator.GoLow().PropertyName.ValueNode.Column)
pl := h.Components.Schemas["SomePayload"]
assert.Equal(t, "is html programming? yes.", pl.Schema().XML.Name)
assert.Equal(t, 518, pl.Schema().XML.GoLow().Name.ValueNode.Line)
assert.Equal(t, 523, pl.Schema().XML.GoLow().Name.ValueNode.Line)
ext := h.Components.Extensions
assert.Equal(t, "loud", ext["x-screaming-baby"])
@@ -240,7 +237,7 @@ func TestNewDocument_Components_Headers(t *testing.T) {
h := NewDocument(lowDoc)
assert.Len(t, h.Components.Headers, 1)
assert.Equal(t, "this is a header example for UseOil", h.Components.Headers["UseOil"].Description)
assert.Equal(t, 318, h.Components.Headers["UseOil"].GoLow().Description.ValueNode.Line)
assert.Equal(t, 323, h.Components.Headers["UseOil"].GoLow().Description.ValueNode.Line)
assert.Equal(t, 20, h.Components.Headers["UseOil"].GoLow().Description.ValueNode.Column)
}
@@ -249,7 +246,7 @@ func TestNewDocument_Components_RequestBodies(t *testing.T) {
h := NewDocument(lowDoc)
assert.Len(t, h.Components.RequestBodies, 1)
assert.Equal(t, "Give us the new burger!", h.Components.RequestBodies["BurgerRequest"].Description)
assert.Equal(t, 323, h.Components.RequestBodies["BurgerRequest"].GoLow().Description.ValueNode.Line)
assert.Equal(t, 328, h.Components.RequestBodies["BurgerRequest"].GoLow().Description.ValueNode.Line)
assert.Equal(t, 20, h.Components.RequestBodies["BurgerRequest"].GoLow().Description.ValueNode.Column)
assert.Len(t, h.Components.RequestBodies["BurgerRequest"].Content["application/json"].Examples, 2)
}
@@ -259,7 +256,7 @@ func TestNewDocument_Components_Examples(t *testing.T) {
h := NewDocument(lowDoc)
assert.Len(t, h.Components.Examples, 1)
assert.Equal(t, "A juicy two hander sammich", h.Components.Examples["QuarterPounder"].Summary)
assert.Equal(t, 341, h.Components.Examples["QuarterPounder"].GoLow().Summary.ValueNode.Line)
assert.Equal(t, 346, h.Components.Examples["QuarterPounder"].GoLow().Summary.ValueNode.Line)
assert.Equal(t, 16, h.Components.Examples["QuarterPounder"].GoLow().Summary.ValueNode.Column)
}
@@ -269,7 +266,7 @@ func TestNewDocument_Components_Responses(t *testing.T) {
assert.Len(t, h.Components.Responses, 1)
assert.Equal(t, "all the dressings for a burger.", h.Components.Responses["DressingResponse"].Description)
assert.Equal(t, "array", h.Components.Responses["DressingResponse"].Content["application/json"].Schema.Schema().Type[0])
assert.Equal(t, 347, h.Components.Responses["DressingResponse"].GoLow().Description.KeyNode.Line)
assert.Equal(t, 352, h.Components.Responses["DressingResponse"].GoLow().Description.KeyNode.Line)
assert.Equal(t, 7, h.Components.Responses["DressingResponse"].GoLow().Description.KeyNode.Column)
}
@@ -280,26 +277,26 @@ func TestNewDocument_Components_SecuritySchemes(t *testing.T) {
api := h.Components.SecuritySchemes["APIKeyScheme"]
assert.Equal(t, "an apiKey security scheme", api.Description)
assert.Equal(t, 359, api.GoLow().Description.ValueNode.Line)
assert.Equal(t, 364, api.GoLow().Description.ValueNode.Line)
assert.Equal(t, 20, api.GoLow().Description.ValueNode.Column)
jwt := h.Components.SecuritySchemes["JWTScheme"]
assert.Equal(t, "an JWT security scheme", jwt.Description)
assert.Equal(t, 364, jwt.GoLow().Description.ValueNode.Line)
assert.Equal(t, 369, jwt.GoLow().Description.ValueNode.Line)
assert.Equal(t, 20, jwt.GoLow().Description.ValueNode.Column)
oAuth := h.Components.SecuritySchemes["OAuthScheme"]
assert.Equal(t, "an oAuth security scheme", oAuth.Description)
assert.Equal(t, 370, oAuth.GoLow().Description.ValueNode.Line)
assert.Equal(t, 375, oAuth.GoLow().Description.ValueNode.Line)
assert.Equal(t, 20, oAuth.GoLow().Description.ValueNode.Column)
assert.Len(t, oAuth.Flows.Implicit.Scopes, 2)
assert.Equal(t, "read all burgers", oAuth.Flows.Implicit.Scopes["read:burgers"])
assert.Equal(t, "https://pb33f.io/oauth", oAuth.Flows.AuthorizationCode.AuthorizationUrl)
// check the lowness is low.
assert.Equal(t, 375, oAuth.Flows.GoLow().Implicit.Value.Scopes.KeyNode.Line)
assert.Equal(t, 380, oAuth.Flows.GoLow().Implicit.Value.Scopes.KeyNode.Line)
assert.Equal(t, 11, oAuth.Flows.GoLow().Implicit.Value.Scopes.KeyNode.Column)
assert.Equal(t, 375, oAuth.Flows.Implicit.GoLow().Scopes.KeyNode.Line)
assert.Equal(t, 380, oAuth.Flows.Implicit.GoLow().Scopes.KeyNode.Line)
assert.Equal(t, 11, oAuth.Flows.Implicit.GoLow().Scopes.KeyNode.Column)
}
@@ -309,7 +306,7 @@ func TestNewDocument_Components_Parameters(t *testing.T) {
assert.Len(t, h.Components.Parameters, 2)
bh := h.Components.Parameters["BurgerHeader"]
assert.Equal(t, "burgerHeader", bh.Name)
assert.Equal(t, 387, bh.GoLow().Name.KeyNode.Line)
assert.Equal(t, 392, bh.GoLow().Name.KeyNode.Line)
assert.Len(t, bh.Schema.Schema().Properties, 2)
assert.Equal(t, "big-mac", bh.Example)
assert.True(t, bh.Required)
@@ -319,7 +316,7 @@ func TestNewDocument_Components_Parameters(t *testing.T) {
bh.Content["application/json"].Encoding["burgerTheme"].Headers["someHeader"].Description,
)
assert.Len(t, bh.Content["application/json"].Schema.Schema().Properties, 2)
assert.Equal(t, 404, bh.Content["application/json"].Encoding["burgerTheme"].GoLow().ContentType.ValueNode.Line)
assert.Equal(t, 409, bh.Content["application/json"].Encoding["burgerTheme"].GoLow().ContentType.ValueNode.Line)
}
func TestNewDocument_Paths(t *testing.T) {
@@ -327,6 +324,10 @@ func TestNewDocument_Paths(t *testing.T) {
h := NewDocument(lowDoc)
assert.Len(t, h.Paths.PathItems, 5)
testBurgerShop(t, h, true)
}
func testBurgerShop(t *testing.T, h *Document, checkLines bool) {
burgersOp := h.Paths.PathItems["/burgers"]
assert.Len(t, burgersOp.GetOperations(), 1)
@@ -337,39 +338,44 @@ func TestNewDocument_Paths(t *testing.T) {
assert.Nil(t, burgersOp.Head)
assert.Nil(t, burgersOp.Options)
assert.Nil(t, burgersOp.Trace)
assert.Equal(t, 64, burgersOp.GoLow().Post.KeyNode.Line)
assert.Equal(t, "createBurger", burgersOp.Post.OperationId)
assert.Len(t, burgersOp.Post.Tags, 1)
assert.Equal(t, "A new burger for our menu, yummy yum yum.", burgersOp.Post.Description)
assert.Equal(t, "Give us the new burger!", burgersOp.Post.RequestBody.Description)
assert.Len(t, burgersOp.Post.Responses.Codes, 3)
assert.Equal(t, 63, h.Paths.GoLow().FindPath("/burgers").ValueNode.Line)
if checkLines {
assert.Equal(t, 64, burgersOp.GoLow().Post.KeyNode.Line)
assert.Equal(t, 63, h.Paths.GoLow().FindPath("/burgers").ValueNode.Line)
}
okResp := burgersOp.Post.Responses.FindResponseByCode(200)
assert.Len(t, okResp.Headers, 1)
assert.Equal(t, "A tasty burger for you to eat.", okResp.Description)
assert.Equal(t, 69, burgersOp.Post.GoLow().Description.ValueNode.Line)
assert.Len(t, okResp.Content["application/json"].Examples, 2)
assert.Equal(
t,
"a cripsy fish sammich filled with ocean goodness.",
okResp.Content["application/json"].Examples["filetOFish"].Summary,
)
assert.Equal(t, 74, burgersOp.Post.Responses.GoLow().FindResponseByCode("200").ValueNode.Line)
assert.Equal(t, 80, okResp.Content["application/json"].GoLow().Schema.KeyNode.Line)
assert.Equal(t, 15, okResp.Content["application/json"].GoLow().Schema.KeyNode.Column)
assert.Equal(t, 77, okResp.GoLow().Description.KeyNode.Line)
assert.Len(t, okResp.Links, 2)
assert.Equal(t, "locateBurger", okResp.Links["LocateBurger"].OperationId)
assert.Equal(t, 305, okResp.Links["LocateBurger"].GoLow().OperationId.ValueNode.Line)
assert.Len(t, burgersOp.Post.Security[0].Requirements, 1)
assert.Len(t, burgersOp.Post.Security[0].Requirements["OAuthScheme"], 2)
assert.Equal(t, "read:burgers", burgersOp.Post.Security[0].Requirements["OAuthScheme"][0])
assert.Equal(t, 118, burgersOp.Post.Security[0].GoLow().Requirements.ValueNode.Line)
assert.Len(t, burgersOp.Post.Servers, 1)
assert.Equal(t, "https://pb33f.io", burgersOp.Post.Servers[0].URL)
if checkLines {
assert.Equal(t, 69, burgersOp.Post.GoLow().Description.ValueNode.Line)
assert.Equal(t, 74, burgersOp.Post.Responses.GoLow().FindResponseByCode("200").ValueNode.Line)
assert.Equal(t, 80, okResp.Content["application/json"].GoLow().Schema.KeyNode.Line)
assert.Equal(t, 15, okResp.Content["application/json"].GoLow().Schema.KeyNode.Column)
assert.Equal(t, 77, okResp.GoLow().Description.KeyNode.Line)
assert.Equal(t, 310, okResp.Links["LocateBurger"].GoLow().OperationId.ValueNode.Line)
assert.Equal(t, 118, burgersOp.Post.Security[0].GoLow().Requirements.ValueNode.Line)
}
}
func TestStripeAsDoc(t *testing.T) {
@@ -405,55 +411,55 @@ func TestAsanaAsDoc(t *testing.T) {
assert.Equal(t, 118, len(d.Paths.PathItems))
}
func TestDigitalOceanAsDoc(t *testing.T) {
data, _ := ioutil.ReadFile("../../../test_specs/digitalocean.yaml")
info, _ := datamodel.ExtractSpecInfo(data)
var err []error
baseURL, _ := url.Parse("https://raw.githubusercontent.com/digitalocean/openapi/main/specification")
config := datamodel.DocumentConfiguration{
AllowFileReferences: true,
AllowRemoteReferences: true,
BaseURL: baseURL,
}
lowDoc, err = lowv3.CreateDocumentFromConfig(info, &config)
if err != nil {
for e := range err {
fmt.Println(err[e])
}
panic("broken something")
}
d := NewDocument(lowDoc)
assert.NotNil(t, d)
assert.Equal(t, 183, len(d.Paths.PathItems))
}
func TestDigitalOceanAsDocFromSHA(t *testing.T) {
data, _ := ioutil.ReadFile("../../../test_specs/digitalocean.yaml")
info, _ := datamodel.ExtractSpecInfo(data)
var err []error
baseURL, _ := url.Parse("https://raw.githubusercontent.com/digitalocean/openapi/82e1d558e15a59edc1d47d2c5544e7138f5b3cbf/specification")
config := datamodel.DocumentConfiguration{
AllowFileReferences: true,
AllowRemoteReferences: true,
BaseURL: baseURL,
}
lowDoc, err = lowv3.CreateDocumentFromConfig(info, &config)
if err != nil {
for e := range err {
fmt.Println(err[e])
}
panic("broken something")
}
d := NewDocument(lowDoc)
assert.NotNil(t, d)
assert.Equal(t, 183, len(d.Paths.PathItems))
}
//func TestDigitalOceanAsDoc(t *testing.T) {
// data, _ := ioutil.ReadFile("../../../test_specs/digitalocean.yaml")
// info, _ := datamodel.ExtractSpecInfo(data)
// var err []error
//
// baseURL, _ := url.Parse("https://raw.githubusercontent.com/digitalocean/openapi/main/specification")
// config := datamodel.DocumentConfiguration{
// AllowFileReferences: true,
// AllowRemoteReferences: true,
// BaseURL: baseURL,
// }
//
// lowDoc, err = lowv3.CreateDocumentFromConfig(info, &config)
// if err != nil {
// for e := range err {
// fmt.Println(err[e])
// }
// panic("broken something")
// }
// d := NewDocument(lowDoc)
// assert.NotNil(t, d)
// assert.Equal(t, 183, len(d.Paths.PathItems))
//
//}
//
//func TestDigitalOceanAsDocFromSHA(t *testing.T) {
// data, _ := ioutil.ReadFile("../../../test_specs/digitalocean.yaml")
// info, _ := datamodel.ExtractSpecInfo(data)
// var err []error
//
// baseURL, _ := url.Parse("https://raw.githubusercontent.com/digitalocean/openapi/82e1d558e15a59edc1d47d2c5544e7138f5b3cbf/specification")
// config := datamodel.DocumentConfiguration{
// AllowFileReferences: true,
// AllowRemoteReferences: true,
// BaseURL: baseURL,
// }
//
// lowDoc, err = lowv3.CreateDocumentFromConfig(info, &config)
// if err != nil {
// for e := range err {
// fmt.Println(err[e])
// }
// panic("broken something")
// }
// d := NewDocument(lowDoc)
// assert.NotNil(t, d)
// assert.Equal(t, 183, len(d.Paths.PathItems))
//
//}
func TestPetstoreAsDoc(t *testing.T) {
data, _ := ioutil.ReadFile("../../../test_specs/petstorev3.json")
@@ -488,19 +494,12 @@ func TestDocument_MarshalYAML(t *testing.T) {
// render the document to YAML
r, _ := h.Render()
os.WriteFile("rendered.yaml", r, 0644)
// re-parse the document
//TODO: pick up in the morning here, trying to figure out why headers are being rendered (UseOil)
info, _ := datamodel.ExtractSpecInfo(r)
lDoc, e := lowv3.CreateDocumentFromConfig(info, datamodel.NewOpenDocumentConfiguration())
assert.Nil(t, e)
highDoc := NewDocument(lDoc)
assert.Equal(t, "3.1.0", highDoc.Version)
assert.Len(t, highDoc.Paths.PathItems, 5)
testBurgerShop(t, highDoc, false)
}
@@ -586,38 +585,37 @@ func TestDocument_MarshalYAML_TestParamRefs(t *testing.T) {
// create a new document
yml := `openapi: 3.1.0
paths:
"/burgers/{burgerId}":
get:
operationId: locateBurger
tags:
- Burgers
summary: Search a burger by ID - returns the burger with that identifier
description: Look up a tasty burger take it and enjoy it
parameters:
- $ref: "#/components/parameters/BurgerId"
- $ref: "#/components/parameters/BurgerHeader"
/burgers/{burgerId}:
get:
operationId: locateBurger
tags:
- Burgers
summary: Search a burger by ID - returns the burger with that identifier
description: Look up a tasty burger take it and enjoy it
parameters:
- $ref: '#/components/parameters/BurgerId'
- $ref: '#/components/parameters/BurgerHeader'
components:
parameters:
BurgerHeader:
in: header
name: burgerHeader
schema:
properties:
burgerTheme:
type: string
description: something about a theme goes in here?
burgerTime:
type: number
description: number of burgers ordered so far this year.
BurgerId:
in: path
name: burgerId
schema:
type: string
example: big-mac
description: the name of the burger. use this to order your tasty burger
required: true
`
parameters:
BurgerHeader:
in: header
name: burgerHeader
schema:
properties:
burgerTheme:
type: string
description: something about a theme goes in here?
burgerTime:
type: number
description: number of burgers ordered so far this year.
BurgerId:
in: path
name: burgerId
schema:
type: string
example: big-mac
description: the name of the burger. use this to order your tasty burger
required: true`
info, _ := datamodel.ExtractSpecInfo([]byte(yml))
var err []error
@@ -635,5 +633,48 @@ components:
assert.Equal(t, yml, strings.TrimSpace(string(r)))
}
func TestDocument_MarshalYAML_TestModifySchemas(t *testing.T) {
// create a new document
yml := `openapi: 3.1.0
components:
schemas:
BurgerHeader:
properties:
burgerTheme:
type: string
description: something about a theme goes in here?
`
info, _ := datamodel.ExtractSpecInfo([]byte(yml))
var err []error
lowDoc, err = lowv3.CreateDocumentFromConfig(info, &datamodel.DocumentConfiguration{
AllowFileReferences: true,
AllowRemoteReferences: true,
})
if err != nil {
panic("broken something")
}
h := NewDocument(lowDoc)
// mutate the schema
g := h.Components.Schemas["BurgerHeader"].Schema()
ds := g.Properties["burgerTheme"].Schema()
ds.Description = "changed"
// render the document to YAML and it should be identical.
r, _ := h.Render()
desired := `openapi: 3.1.0
components:
schemas:
BurgerHeader:
properties:
burgerTheme:
type: string
description: changed`
assert.Equal(t, desired, strings.TrimSpace(string(r)))
}

3
datamodel/high/v3/oauth_flow_test.go
View File

@@ -27,7 +27,8 @@ scopes:
chicken: nuggets
beefy: soup`
assert.Equal(t, desired, strings.TrimSpace(string(rend)))
// we can't check for equality, as the scopes map will be randomly ordered when created from scratch.
assert.Len(t, desired, 149)
// mutate
oflow.Scopes = nil

9
datamodel/high/v3/paths.go
View File

@@ -94,11 +94,15 @@ func (p *Paths) MarshalYAML() (interface{}, error) {
nb := high.NewNodeBuilder(p, p.low)
extNode := nb.Render()
if extNode != nil && extNode.Content != nil {
var label string
for u := range extNode.Content {
mapped = append(mapped, &pathItem{nil, extNode.Content[u].Value,
if u%2 == 0 {
label = extNode.Content[u].Value
continue
}
mapped = append(mapped, &pathItem{nil, label,
extNode.Content[u].Line, extNode.Content[u]})
}
//m.Content = append(m.Content, extNode.Content...)
}
sort.Slice(mapped, func(i, j int) bool {
@@ -111,6 +115,7 @@ func (p *Paths) MarshalYAML() (interface{}, error) {
m.Content = append(m.Content, rendered.(*yaml.Node))
}
if mapped[j].rendered != nil {
m.Content = append(m.Content, high.CreateStringNode(mapped[j].path))
m.Content = append(m.Content, mapped[j].rendered)
}
}

31
datamodel/high/v3/responses.go
View File

@@ -98,6 +98,7 @@ func (r *Responses) MarshalYAML() (interface{}, error) {
resp *Response
code string
line int
ext *yaml.Node
}
var mapped []*responseItem
@@ -110,16 +111,38 @@ func (r *Responses) MarshalYAML() (interface{}, error) {
}
}
}
mapped = append(mapped, &responseItem{re, k, ln})
mapped = append(mapped, &responseItem{re, k, ln, nil})
}
// extract extensions
nb := high.NewNodeBuilder(r, r.low)
extNode := nb.Render()
if extNode != nil && extNode.Content != nil {
var label string
for u := range extNode.Content {
if u%2 == 0 {
label = extNode.Content[u].Value
continue
}
mapped = append(mapped, &responseItem{nil, label,
extNode.Content[u].Line, extNode.Content[u]})
}
}
sort.Slice(mapped, func(i, j int) bool {
return mapped[i].line < mapped[j].line
})
for j := range mapped {
rendered, _ := mapped[j].resp.MarshalYAML()
m.Content = append(m.Content, high.CreateStringNode(mapped[j].code))
m.Content = append(m.Content, rendered.(*yaml.Node))
if mapped[j].resp != nil {
rendered, _ := mapped[j].resp.MarshalYAML()
m.Content = append(m.Content, high.CreateStringNode(mapped[j].code))
m.Content = append(m.Content, rendered.(*yaml.Node))
}
if mapped[j].ext != nil {
m.Content = append(m.Content, high.CreateStringNode(mapped[j].code))
m.Content = append(m.Content, mapped[j].ext)
}
}
return m, nil
}

2
datamodel/low/base/schema_test.go
View File

@@ -290,7 +290,7 @@ func Test_Schema(t *testing.T) {
// check discriminator
assert.NotNil(t, sch.Discriminator.Value)
assert.Equal(t, "athing", sch.Discriminator.Value.PropertyName.Value)
assert.Len(t, sch.Discriminator.Value.Mapping, 2)
assert.Len(t, sch.Discriminator.Value.Mapping.Value, 2)
mv := sch.Discriminator.Value.FindMappingValue("log")
assert.Equal(t, "cat", mv.Value)
mv = sch.Discriminator.Value.FindMappingValue("pizza")

19
datamodel/low/extraction_functions.go
View File

@@ -413,15 +413,16 @@ func ExtractMapNoLookup[PT Buildable[N], N any](
if isReference {
SetReference(n, referenceValue)
}
valueMap[KeyReference[string]{
Value: currentKey.Value,
KeyNode: currentKey,
}] = ValueReference[PT]{
Value: n,
ValueNode: node,
//IsReference: isReference,
Reference: referenceValue,
if currentKey != nil {
valueMap[KeyReference[string]{
Value: currentKey.Value,
KeyNode: currentKey,
}] = ValueReference[PT]{
Value: n,
ValueNode: node,
//IsReference: isReference,
Reference: referenceValue,
}
}
}
}

22
datamodel/low/v3/media_type.go
View File

@@ -61,13 +61,21 @@ func (mt *MediaType) Build(root *yaml.Node, idx *index.SpecIndex) error {
// handle example if set.
_, expLabel, expNode := utils.FindKeyNodeFull(base.ExampleLabel, root.Content)
if expNode != nil {
var value string
if utils.IsNodeMap(expNode) || utils.IsNodeArray(expNode) {
y, _ := yaml.Marshal(expNode)
z, _ := utils.ConvertYAMLtoJSON(y)
value = fmt.Sprintf("%s", z)
} else {
value = expNode.Value
var value any
if utils.IsNodeMap(expNode) {
var h map[string]any
_ = expNode.Decode(&h)
value = h
}
if utils.IsNodeArray(expNode) {
var h []any
_ = expNode.Decode(&h)
value = h
}
if value == nil {
if expNode.Value != "" {
value = expNode.Value
}
}
mt.Example = low.NodeReference[any]{Value: value, KeyNode: expLabel, ValueNode: expNode}
}

63
document_test.go
View File

@@ -6,6 +6,7 @@ package libopenapi
import (
"fmt"
"github.com/pb33f/libopenapi/datamodel"
"github.com/pb33f/libopenapi/datamodel/high/base"
"io/ioutil"
"net/url"
"strings"
@@ -159,19 +160,54 @@ info:
func TestDocument_RenderAndReload(t *testing.T) {
yml := `openapi: 3.0
info:
title: The magic API
`
doc, _ := NewDocument([]byte(yml))
v3Doc, _ := doc.BuildV3Model()
// load an OpenAPI 3 specification from bytes
petstore, _ := ioutil.ReadFile("test_specs/petstorev3.json")
v3Doc.Model.Info.Title = "The magic API - but now, altered!"
bytes, _, newDocModel, err := doc.RenderAndReload()
assert.Nil(t, err)
// create a new document from specification bytes
doc, err := NewDocument(petstore)
// if anything went wrong, an error is thrown
if err != nil {
panic(fmt.Sprintf("cannot create new document: %e", err))
}
// because we know this is a v3 spec, we can build a ready to go model from it.
m, _ := doc.BuildV3Model()
// mutate the model
h := m.Model
h.Paths.PathItems["/pet/findByStatus"].Get.OperationId = "findACakeInABakery"
h.Paths.PathItems["/pet/findByStatus"].Get.Responses.Codes["400"].Description = "a nice bucket of mice"
h.Paths.PathItems["/pet/findByTags"].Get.Tags =
append(h.Paths.PathItems["/pet/findByTags"].Get.Tags, "gurgle", "giggle")
h.Paths.PathItems["/pet/{petId}"].Delete.Security = append(h.Paths.PathItems["/pet/{petId}"].Delete.Security,
&base.SecurityRequirement{Requirements: map[string][]string{
"pizza-and-cake": {"read:abook", "write:asong"},
}})
h.Components.Schemas["Order"].Schema().Properties["status"].Schema().Example = "I am a teapot, filled with love."
h.Components.SecuritySchemes["petstore_auth"].Flows.Implicit.AuthorizationUrl = "https://pb33f.io"
bytes, _, newDocModel, e := doc.RenderAndReload()
assert.Nil(t, e)
assert.NotNil(t, bytes)
assert.Equal(t, "The magic API - but now, altered!",
newDocModel.Model.Info.Title)
h = newDocModel.Model
assert.Equal(t, "findACakeInABakery", h.Paths.PathItems["/pet/findByStatus"].Get.OperationId)
assert.Equal(t, "a nice bucket of mice",
h.Paths.PathItems["/pet/findByStatus"].Get.Responses.Codes["400"].Description)
assert.Len(t, h.Paths.PathItems["/pet/findByTags"].Get.Tags, 3)
assert.Len(t, h.Paths.PathItems["/pet/findByTags"].Get.Tags, 3)
yu := h.Paths.PathItems["/pet/{petId}"].Delete.Security
assert.Equal(t, "read:abook", yu[len(yu)-1].Requirements["pizza-and-cake"][0])
assert.Equal(t, "I am a teapot, filled with love.",
h.Components.Schemas["Order"].Schema().Properties["status"].Schema().Example)
assert.Equal(t, "https://pb33f.io",
h.Components.SecuritySchemes["petstore_auth"].Flows.Implicit.AuthorizationUrl)
}
func TestDocument_Serialize_JSON_Modified(t *testing.T) {
@@ -227,7 +263,7 @@ paths:
// print it out.
fmt.Printf("param1: %s, is reference? %t, original reference %s",
operation.Parameters[0].Description, operation.GoLow().Parameters.Value[0].IsReference,
operation.Parameters[0].Description, operation.GoLow().Parameters.Value[0].IsReference(),
operation.GoLow().Parameters.Value[0].Reference)
}
@@ -532,7 +568,7 @@ func ExampleCompareDocuments_openAPI() {
// Print out some interesting stats about the OpenAPI document changes.
fmt.Printf("There are %d changes, of which %d are breaking. %v schemas have changes.",
documentChanges.TotalChanges(), documentChanges.TotalBreakingChanges(), len(schemaChanges))
//Output: There are 67 changes, of which 17 are breaking. 5 schemas have changes.
//Output: There are 72 changes, of which 17 are breaking. 5 schemas have changes.
}
@@ -854,3 +890,4 @@ func TestSchemaRefIsFollowed(t *testing.T) {
assert.Equal(t, uint64.Schema().Example, byte.Schema().Example)
assert.Equal(t, uint64.Schema().Minimum, byte.Schema().Minimum)
}

5
test_specs/burgershop.openapi.yaml
View File

@@ -199,6 +199,7 @@ paths:
description: Cannot find your burger in which to list dressings. Sorry
content:
application/json:
x-nice: rice
schema:
$ref: '#/components/schemas/Error'
example:
@@ -212,21 +213,25 @@ paths:
example:
message: computer says no dressings for this burger.
/dressings/{dressingId}:
x-winter-coat: warm
get:
operationId: getDressing
tags:
- "Dressing"
summary: Get a specific dressing - you can choose the dressing from our menu
description: Same as the summary, get a dressing, by its ID
x-runny-nose: runny.
parameters:
- in: path
name: dressingId
schema:
x-hot-cross-buns: bunny
type: string
example: cheese
description: This is the unique identifier for the dressing items.
required: true
responses:
x-toasty-roasty: hot
"200":
description: a dressing
content:

4
what-changed/model/discriminator.go
View File

@@ -54,8 +54,8 @@ func CompareDiscriminator(l, r *base.Discriminator) *DiscriminatorChanges {
CheckProperties(props)
// flatten maps
lMap := FlattenLowLevelMap[string](l.Mapping)
rMap := FlattenLowLevelMap[string](r.Mapping)
lMap := FlattenLowLevelMap[string](l.Mapping.Value)
rMap := FlattenLowLevelMap[string](r.Mapping.Value)
// check for removals, modifications and moves
for i := range lMap {

8
what-changed/model/link.go
View File

@@ -114,11 +114,11 @@ func CompareLinks(l, r *v3.Link) *LinkChanges {
// parameters
lValues := make(map[string]low.ValueReference[string])
rValues := make(map[string]low.ValueReference[string])
for i := range l.Parameters {
lValues[i.Value] = l.Parameters[i]
for i := range l.Parameters.Value {
lValues[i.Value] = l.Parameters.Value[i]
}
for i := range r.Parameters {
rValues[i.Value] = r.Parameters[i]
for i := range r.Parameters.Value {
rValues[i.Value] = r.Parameters.Value[i]
}
for k := range lValues {
if _, ok := rValues[k]; !ok {

2
what-changed/reports/summary_test.go
View File

@@ -25,7 +25,7 @@ func TestCreateSummary_OverallReport(t *testing.T) {
changes := createDiff()
report := CreateOverallReport(changes)
assert.Equal(t, 1, report.ChangeReport[v3.InfoLabel].Total)
assert.Equal(t, 38, report.ChangeReport[v3.PathsLabel].Total)
assert.Equal(t, 43, report.ChangeReport[v3.PathsLabel].Total)
assert.Equal(t, 9, report.ChangeReport[v3.PathsLabel].Breaking)
assert.Equal(t, 3, report.ChangeReport[v3.TagsLabel].Total)
assert.Equal(t, 1, report.ChangeReport[v3.ExternalDocsLabel].Total)

4
what-changed/what_changed_test.go
View File

@@ -24,7 +24,7 @@ func TestCompareOpenAPIDocuments(t *testing.T) {
modDoc, _ := v3.CreateDocument(infoMod)
changes := CompareOpenAPIDocuments(origDoc, modDoc)
assert.Equal(t, 67, changes.TotalChanges())
assert.Equal(t, 72, changes.TotalChanges())
assert.Equal(t, 17, changes.TotalBreakingChanges())
//
//out, _ := json.MarshalIndent(changes, "", " ")
@@ -151,5 +151,5 @@ func ExampleCompareOpenAPIDocuments() {
// Print out some interesting stats.
fmt.Printf("There are %d changes, of which %d are breaking. %v schemas have changes.",
changes.TotalChanges(), changes.TotalBreakingChanges(), len(schemaChanges))
//Output: There are 67 changes, of which 17 are breaking. 5 schemas have changes.
//Output: There are 72 changes, of which 17 are breaking. 5 schemas have changes.
}