Files
libopenapi/datamodel/high/v2/header.go
Dave Shanley 61f99b8fd6 Replacing extensions hash code **breaking change**
This is a large update, I realized that extensions are not being hashed correctly, and because I have the same code everywhere, it means running back through the stack and cleaning up the invalid code that will break if multiple extensions are used in different positions in the raw spec.

At the same time, I realized that the v2 model has the same primitive/enum issues that are part cleaned up in v3. This is a breaking changhe because enums are now []any and not []string, as well as primitives for bool, int etc are all pointers now instead of the copied values.

This will break any consumers.
2022-11-18 11:00:34 -05:00

107 lines
2.8 KiB
Go

// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT
package v2
import (
"github.com/pb33f/libopenapi/datamodel/high"
low "github.com/pb33f/libopenapi/datamodel/low/v2"
)
// Header Represents a high-level Swagger / OpenAPI 2 Header object, backed by a low-level one.
// A Header is essentially identical to a Parameter, except it does not contain 'name' or 'in' properties.
// - https://swagger.io/specification/v2/#headerObject
type Header struct {
Type string
Format string
Description string
Items *Items
CollectionFormat string
Default any
Maximum int
ExclusiveMaximum bool
Minimum int
ExclusiveMinimum bool
MaxLength int
MinLength int
Pattern string
MaxItems int
MinItems int
UniqueItems bool
Enum []any
MultipleOf int
Extensions map[string]any
low *low.Header
}
// NewHeader will create a new high-level Swagger / OpenAPI 2 Header instance, from a low-level one.
func NewHeader(header *low.Header) *Header {
h := new(Header)
h.low = header
h.Extensions = high.ExtractExtensions(header.Extensions)
if !header.Type.IsEmpty() {
h.Type = header.Type.Value
}
if !header.Format.IsEmpty() {
h.Format = header.Type.Value
}
if !header.Description.IsEmpty() {
h.Description = header.Description.Value
}
if !header.Items.IsEmpty() {
h.Items = NewItems(header.Items.Value)
}
if !header.CollectionFormat.IsEmpty() {
h.CollectionFormat = header.CollectionFormat.Value
}
if !header.Default.IsEmpty() {
h.Default = header.Default.Value
}
if !header.Maximum.IsEmpty() {
h.Maximum = header.Maximum.Value
}
if !header.ExclusiveMaximum.IsEmpty() {
h.ExclusiveMaximum = header.ExclusiveMaximum.Value
}
if !header.Minimum.IsEmpty() {
h.Minimum = header.Minimum.Value
}
if !header.ExclusiveMinimum.Value {
h.ExclusiveMinimum = header.ExclusiveMinimum.Value
}
if !header.MaxLength.IsEmpty() {
h.MaxLength = header.MaxLength.Value
}
if !header.MinLength.IsEmpty() {
h.MinLength = header.MinLength.Value
}
if !header.Pattern.IsEmpty() {
h.Pattern = header.Pattern.Value
}
if !header.MinItems.IsEmpty() {
h.MinItems = header.MinItems.Value
}
if !header.MaxItems.IsEmpty() {
h.MaxItems = header.MaxItems.Value
}
if !header.UniqueItems.IsEmpty() {
h.UniqueItems = header.UniqueItems.IsEmpty()
}
if !header.Enum.IsEmpty() {
var enums []any
for e := range header.Enum.Value {
enums = append(enums, header.Enum.Value[e].Value)
}
h.Enum = enums
}
if !header.MultipleOf.IsEmpty() {
h.MultipleOf = header.MultipleOf.Value
}
return h
}
// GoLow returns the low-level header used to create the high-level one.
func (h *Header) GoLow() *low.Header {
return h.low
}