mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-10 04:20:24 +00:00
Added support for unevaluatedProperties as Schema and bool #118
Also ran `gofmt` across the entire project. Things need cleaning up. Signed-off-by: Dave Shanley <dave@quobix.com>
This commit is contained in:
Dave Shanley
@@ -4,196 +4,196 @@
|
||||
package model
|
||||
|
||||
import (
|
||||
"github.com/pb33f/libopenapi/datamodel/low"
|
||||
v3 "github.com/pb33f/libopenapi/datamodel/low/v3"
|
||||
"reflect"
|
||||
"github.com/pb33f/libopenapi/datamodel/low"
|
||||
v3 "github.com/pb33f/libopenapi/datamodel/low/v3"
|
||||
"reflect"
|
||||
)
|
||||
|
||||
import (
|
||||
"github.com/pb33f/libopenapi/datamodel/low/v2"
|
||||
"github.com/pb33f/libopenapi/datamodel/low/v2"
|
||||
)
|
||||
|
||||
// ResponseChanges represents changes found between two Swagger or OpenAPI Response objects.
|
||||
type ResponseChanges struct {
|
||||
*PropertyChanges
|
||||
ExtensionChanges *ExtensionChanges `json:"extensions,omitempty" yaml:"extensions,omitempty"`
|
||||
HeadersChanges map[string]*HeaderChanges `json:"headers,omitempty" yaml:"headers,omitempty"`
|
||||
*PropertyChanges
|
||||
ExtensionChanges *ExtensionChanges `json:"extensions,omitempty" yaml:"extensions,omitempty"`
|
||||
HeadersChanges map[string]*HeaderChanges `json:"headers,omitempty" yaml:"headers,omitempty"`
|
||||
|
||||
// Swagger Response Properties.
|
||||
SchemaChanges *SchemaChanges `json:"schemas,omitempty" yaml:"schemas,omitempty"`
|
||||
ExamplesChanges *ExamplesChanges `json:"examples,omitempty" yaml:"examples,omitempty"`
|
||||
// Swagger Response Properties.
|
||||
SchemaChanges *SchemaChanges `json:"schemas,omitempty" yaml:"schemas,omitempty"`
|
||||
ExamplesChanges *ExamplesChanges `json:"examples,omitempty" yaml:"examples,omitempty"`
|
||||
|
||||
// OpenAPI Response Properties.
|
||||
ContentChanges map[string]*MediaTypeChanges `json:"content,omitempty" yaml:"content,omitempty"`
|
||||
LinkChanges map[string]*LinkChanges `json:"links,omitempty" yaml:"links,omitempty"`
|
||||
// OpenAPI Response Properties.
|
||||
ContentChanges map[string]*MediaTypeChanges `json:"content,omitempty" yaml:"content,omitempty"`
|
||||
LinkChanges map[string]*LinkChanges `json:"links,omitempty" yaml:"links,omitempty"`
|
||||
}
|
||||
|
||||
// GetAllChanges returns a slice of all changes made between RequestBody objects
|
||||
func (r *ResponseChanges) GetAllChanges() []*Change {
|
||||
var changes []*Change
|
||||
changes = append(changes, r.Changes...)
|
||||
if r.ExtensionChanges != nil {
|
||||
changes = append(changes, r.ExtensionChanges.GetAllChanges()...)
|
||||
}
|
||||
if r.SchemaChanges != nil {
|
||||
changes = append(changes, r.SchemaChanges.GetAllChanges()...)
|
||||
}
|
||||
if r.ExamplesChanges != nil {
|
||||
changes = append(changes, r.ExamplesChanges.GetAllChanges()...)
|
||||
}
|
||||
for k := range r.HeadersChanges {
|
||||
changes = append(changes, r.HeadersChanges[k].GetAllChanges()...)
|
||||
}
|
||||
for k := range r.ContentChanges {
|
||||
changes = append(changes, r.ContentChanges[k].GetAllChanges()...)
|
||||
}
|
||||
for k := range r.LinkChanges {
|
||||
changes = append(changes, r.LinkChanges[k].GetAllChanges()...)
|
||||
}
|
||||
return changes
|
||||
var changes []*Change
|
||||
changes = append(changes, r.Changes...)
|
||||
if r.ExtensionChanges != nil {
|
||||
changes = append(changes, r.ExtensionChanges.GetAllChanges()...)
|
||||
}
|
||||
if r.SchemaChanges != nil {
|
||||
changes = append(changes, r.SchemaChanges.GetAllChanges()...)
|
||||
}
|
||||
if r.ExamplesChanges != nil {
|
||||
changes = append(changes, r.ExamplesChanges.GetAllChanges()...)
|
||||
}
|
||||
for k := range r.HeadersChanges {
|
||||
changes = append(changes, r.HeadersChanges[k].GetAllChanges()...)
|
||||
}
|
||||
for k := range r.ContentChanges {
|
||||
changes = append(changes, r.ContentChanges[k].GetAllChanges()...)
|
||||
}
|
||||
for k := range r.LinkChanges {
|
||||
changes = append(changes, r.LinkChanges[k].GetAllChanges()...)
|
||||
}
|
||||
return changes
|
||||
}
|
||||
|
||||
// TotalChanges returns the total number of changes found between two Swagger or OpenAPI Response Objects
|
||||
func (r *ResponseChanges) TotalChanges() int {
|
||||
c := r.PropertyChanges.TotalChanges()
|
||||
if r.ExtensionChanges != nil {
|
||||
c += r.ExtensionChanges.TotalChanges()
|
||||
}
|
||||
if r.SchemaChanges != nil {
|
||||
c += r.SchemaChanges.TotalChanges()
|
||||
}
|
||||
if r.ExamplesChanges != nil {
|
||||
c += r.ExamplesChanges.TotalChanges()
|
||||
}
|
||||
for k := range r.HeadersChanges {
|
||||
c += r.HeadersChanges[k].TotalChanges()
|
||||
}
|
||||
for k := range r.ContentChanges {
|
||||
c += r.ContentChanges[k].TotalChanges()
|
||||
}
|
||||
for k := range r.LinkChanges {
|
||||
c += r.LinkChanges[k].TotalChanges()
|
||||
}
|
||||
return c
|
||||
c := r.PropertyChanges.TotalChanges()
|
||||
if r.ExtensionChanges != nil {
|
||||
c += r.ExtensionChanges.TotalChanges()
|
||||
}
|
||||
if r.SchemaChanges != nil {
|
||||
c += r.SchemaChanges.TotalChanges()
|
||||
}
|
||||
if r.ExamplesChanges != nil {
|
||||
c += r.ExamplesChanges.TotalChanges()
|
||||
}
|
||||
for k := range r.HeadersChanges {
|
||||
c += r.HeadersChanges[k].TotalChanges()
|
||||
}
|
||||
for k := range r.ContentChanges {
|
||||
c += r.ContentChanges[k].TotalChanges()
|
||||
}
|
||||
for k := range r.LinkChanges {
|
||||
c += r.LinkChanges[k].TotalChanges()
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// TotalBreakingChanges returns the total number of breaking changes found between two swagger or OpenAPI
|
||||
// Response Objects
|
||||
func (r *ResponseChanges) TotalBreakingChanges() int {
|
||||
c := r.PropertyChanges.TotalBreakingChanges()
|
||||
if r.SchemaChanges != nil {
|
||||
c += r.SchemaChanges.TotalBreakingChanges()
|
||||
}
|
||||
for k := range r.HeadersChanges {
|
||||
c += r.HeadersChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
for k := range r.ContentChanges {
|
||||
c += r.ContentChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
for k := range r.LinkChanges {
|
||||
c += r.LinkChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
return c
|
||||
c := r.PropertyChanges.TotalBreakingChanges()
|
||||
if r.SchemaChanges != nil {
|
||||
c += r.SchemaChanges.TotalBreakingChanges()
|
||||
}
|
||||
for k := range r.HeadersChanges {
|
||||
c += r.HeadersChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
for k := range r.ContentChanges {
|
||||
c += r.ContentChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
for k := range r.LinkChanges {
|
||||
c += r.LinkChanges[k].TotalBreakingChanges()
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// CompareResponseV2 is a Swagger type safe proxy for CompareResponse
|
||||
func CompareResponseV2(l, r *v2.Response) *ResponseChanges {
|
||||
return CompareResponse(l, r)
|
||||
return CompareResponse(l, r)
|
||||
}
|
||||
|
||||
// CompareResponseV3 is an OpenAPI type safe proxy for CompareResponse
|
||||
func CompareResponseV3(l, r *v3.Response) *ResponseChanges {
|
||||
return CompareResponse(l, r)
|
||||
return CompareResponse(l, r)
|
||||
}
|
||||
|
||||
// CompareResponse compares a left and right Swagger or OpenAPI Response object. If anything is found
|
||||
// a pointer to a ResponseChanges is returned, otherwise it returns nil.
|
||||
func CompareResponse(l, r any) *ResponseChanges {
|
||||
|
||||
var changes []*Change
|
||||
var props []*PropertyCheck
|
||||
var changes []*Change
|
||||
var props []*PropertyCheck
|
||||
|
||||
rc := new(ResponseChanges)
|
||||
rc := new(ResponseChanges)
|
||||
|
||||
if reflect.TypeOf(&v2.Response{}) == reflect.TypeOf(l) && reflect.TypeOf(&v2.Response{}) == reflect.TypeOf(r) {
|
||||
if reflect.TypeOf(&v2.Response{}) == reflect.TypeOf(l) && reflect.TypeOf(&v2.Response{}) == reflect.TypeOf(r) {
|
||||
|
||||
lResponse := l.(*v2.Response)
|
||||
rResponse := r.(*v2.Response)
|
||||
lResponse := l.(*v2.Response)
|
||||
rResponse := r.(*v2.Response)
|
||||
|
||||
// perform hash check to avoid further processing
|
||||
if low.AreEqual(lResponse, rResponse) {
|
||||
return nil
|
||||
}
|
||||
// perform hash check to avoid further processing
|
||||
if low.AreEqual(lResponse, rResponse) {
|
||||
return nil
|
||||
}
|
||||
|
||||
// description
|
||||
addPropertyCheck(&props, lResponse.Description.ValueNode, rResponse.Description.ValueNode,
|
||||
lResponse.Description.Value, rResponse.Description.Value, &changes, v3.DescriptionLabel, false)
|
||||
// description
|
||||
addPropertyCheck(&props, lResponse.Description.ValueNode, rResponse.Description.ValueNode,
|
||||
lResponse.Description.Value, rResponse.Description.Value, &changes, v3.DescriptionLabel, false)
|
||||
|
||||
if !lResponse.Schema.IsEmpty() && !rResponse.Schema.IsEmpty() {
|
||||
rc.SchemaChanges = CompareSchemas(lResponse.Schema.Value, rResponse.Schema.Value)
|
||||
}
|
||||
if !lResponse.Schema.IsEmpty() && rResponse.Schema.IsEmpty() {
|
||||
CreateChange(&changes, ObjectRemoved, v3.SchemaLabel,
|
||||
lResponse.Schema.ValueNode, nil, true,
|
||||
lResponse.Schema.Value, nil)
|
||||
}
|
||||
if lResponse.Schema.IsEmpty() && !rResponse.Schema.IsEmpty() {
|
||||
CreateChange(&changes, ObjectAdded, v3.SchemaLabel,
|
||||
nil, rResponse.Schema.ValueNode, true,
|
||||
nil, rResponse.Schema.Value)
|
||||
}
|
||||
if !lResponse.Schema.IsEmpty() && !rResponse.Schema.IsEmpty() {
|
||||
rc.SchemaChanges = CompareSchemas(lResponse.Schema.Value, rResponse.Schema.Value)
|
||||
}
|
||||
if !lResponse.Schema.IsEmpty() && rResponse.Schema.IsEmpty() {
|
||||
CreateChange(&changes, ObjectRemoved, v3.SchemaLabel,
|
||||
lResponse.Schema.ValueNode, nil, true,
|
||||
lResponse.Schema.Value, nil)
|
||||
}
|
||||
if lResponse.Schema.IsEmpty() && !rResponse.Schema.IsEmpty() {
|
||||
CreateChange(&changes, ObjectAdded, v3.SchemaLabel,
|
||||
nil, rResponse.Schema.ValueNode, true,
|
||||
nil, rResponse.Schema.Value)
|
||||
}
|
||||
|
||||
rc.HeadersChanges =
|
||||
CheckMapForChanges(lResponse.Headers.Value, rResponse.Headers.Value,
|
||||
&changes, v3.HeadersLabel, CompareHeadersV2)
|
||||
rc.HeadersChanges =
|
||||
CheckMapForChanges(lResponse.Headers.Value, rResponse.Headers.Value,
|
||||
&changes, v3.HeadersLabel, CompareHeadersV2)
|
||||
|
||||
if !lResponse.Examples.IsEmpty() && !rResponse.Examples.IsEmpty() {
|
||||
rc.ExamplesChanges = CompareExamplesV2(lResponse.Examples.Value, rResponse.Examples.Value)
|
||||
}
|
||||
if !lResponse.Examples.IsEmpty() && rResponse.Examples.IsEmpty() {
|
||||
CreateChange(&changes, PropertyRemoved, v3.ExamplesLabel,
|
||||
lResponse.Schema.ValueNode, nil, false,
|
||||
lResponse.Schema.Value, nil)
|
||||
}
|
||||
if lResponse.Examples.IsEmpty() && !rResponse.Examples.IsEmpty() {
|
||||
CreateChange(&changes, ObjectAdded, v3.ExamplesLabel,
|
||||
nil, rResponse.Schema.ValueNode, false,
|
||||
nil, lResponse.Schema.Value)
|
||||
}
|
||||
if !lResponse.Examples.IsEmpty() && !rResponse.Examples.IsEmpty() {
|
||||
rc.ExamplesChanges = CompareExamplesV2(lResponse.Examples.Value, rResponse.Examples.Value)
|
||||
}
|
||||
if !lResponse.Examples.IsEmpty() && rResponse.Examples.IsEmpty() {
|
||||
CreateChange(&changes, PropertyRemoved, v3.ExamplesLabel,
|
||||
lResponse.Schema.ValueNode, nil, false,
|
||||
lResponse.Schema.Value, nil)
|
||||
}
|
||||
if lResponse.Examples.IsEmpty() && !rResponse.Examples.IsEmpty() {
|
||||
CreateChange(&changes, ObjectAdded, v3.ExamplesLabel,
|
||||
nil, rResponse.Schema.ValueNode, false,
|
||||
nil, lResponse.Schema.Value)
|
||||
}
|
||||
|
||||
rc.ExtensionChanges = CompareExtensions(lResponse.Extensions, rResponse.Extensions)
|
||||
}
|
||||
rc.ExtensionChanges = CompareExtensions(lResponse.Extensions, rResponse.Extensions)
|
||||
}
|
||||
|
||||
if reflect.TypeOf(&v3.Response{}) == reflect.TypeOf(l) && reflect.TypeOf(&v3.Response{}) == reflect.TypeOf(r) {
|
||||
if reflect.TypeOf(&v3.Response{}) == reflect.TypeOf(l) && reflect.TypeOf(&v3.Response{}) == reflect.TypeOf(r) {
|
||||
|
||||
lResponse := l.(*v3.Response)
|
||||
rResponse := r.(*v3.Response)
|
||||
lResponse := l.(*v3.Response)
|
||||
rResponse := r.(*v3.Response)
|
||||
|
||||
// perform hash check to avoid further processing
|
||||
if low.AreEqual(lResponse, rResponse) {
|
||||
return nil
|
||||
}
|
||||
// perform hash check to avoid further processing
|
||||
if low.AreEqual(lResponse, rResponse) {
|
||||
return nil
|
||||
}
|
||||
|
||||
// description
|
||||
addPropertyCheck(&props, lResponse.Description.ValueNode, rResponse.Description.ValueNode,
|
||||
lResponse.Description.Value, lResponse.Description.Value, &changes, v3.DescriptionLabel, false)
|
||||
// description
|
||||
addPropertyCheck(&props, lResponse.Description.ValueNode, rResponse.Description.ValueNode,
|
||||
lResponse.Description.Value, lResponse.Description.Value, &changes, v3.DescriptionLabel, false)
|
||||
|
||||
rc.HeadersChanges =
|
||||
CheckMapForChanges(lResponse.Headers.Value, rResponse.Headers.Value,
|
||||
&changes, v3.HeadersLabel, CompareHeadersV3)
|
||||
rc.HeadersChanges =
|
||||
CheckMapForChanges(lResponse.Headers.Value, rResponse.Headers.Value,
|
||||
&changes, v3.HeadersLabel, CompareHeadersV3)
|
||||
|
||||
rc.ContentChanges =
|
||||
CheckMapForChanges(lResponse.Content.Value, rResponse.Content.Value,
|
||||
&changes, v3.ContentLabel, CompareMediaTypes)
|
||||
rc.ContentChanges =
|
||||
CheckMapForChanges(lResponse.Content.Value, rResponse.Content.Value,
|
||||
&changes, v3.ContentLabel, CompareMediaTypes)
|
||||
|
||||
rc.LinkChanges =
|
||||
CheckMapForChanges(lResponse.Links.Value, rResponse.Links.Value,
|
||||
&changes, v3.LinksLabel, CompareLinks)
|
||||
rc.LinkChanges =
|
||||
CheckMapForChanges(lResponse.Links.Value, rResponse.Links.Value,
|
||||
&changes, v3.LinksLabel, CompareLinks)
|
||||
|
||||
rc.ExtensionChanges = CompareExtensions(lResponse.Extensions, rResponse.Extensions)
|
||||
}
|
||||
rc.ExtensionChanges = CompareExtensions(lResponse.Extensions, rResponse.Extensions)
|
||||
}
|
||||
|
||||
CheckProperties(props)
|
||||
rc.PropertyChanges = NewPropertyChanges(changes)
|
||||
return rc
|
||||
CheckProperties(props)
|
||||
rc.PropertyChanges = NewPropertyChanges(changes)
|
||||
return rc
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user