libopenapi/datamodel/high/v3/encoding.go

// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT

package v3

import (
	lowmodel "github.com/pb33f/libopenapi/datamodel/low"
	low "github.com/pb33f/libopenapi/datamodel/low/v3"
)

// Encoding represents an OpenAPI 3+ Encoding object
//  - https://spec.openapis.org/oas/v3.1.0#encoding-object
type Encoding struct {
	ContentType   string
	Headers       map[string]*Header
	Style         string
	Explode       bool
	AllowReserved bool
	low           *low.Encoding
}

// NewEncoding creates a new instance of Encoding from a low-level one.
func NewEncoding(encoding *low.Encoding) *Encoding {
	e := new(Encoding)
	e.low = encoding
	e.ContentType = encoding.ContentType.Value
	e.Style = encoding.Style.Value
	e.Explode = encoding.Explode.Value
	e.AllowReserved = encoding.AllowReserved.Value
	e.Headers = ExtractHeaders(encoding.Headers.Value)
	return e
}

// GoLow returns the low-level Encoding instance used to create the high-level one.
func (e *Encoding) GoLow() *low.Encoding {
	return e.low
}

// ExtractEncoding converts hard to navigate low-level plumbing Encoding definitions, into high-level simple map
func ExtractEncoding(elements map[lowmodel.KeyReference[string]]lowmodel.ValueReference[*low.Encoding]) map[string]*Encoding {
	extracted := make(map[string]*Encoding)
	for k, v := range elements {
		extracted[k.Value] = NewEncoding(v.Value)
	}
	return extracted
}