encoding.go

package openapi

import "github.com/MarkRosemaker/errpath"

// Encoding is a single encoding definition applied to a single schema property.
type Encoding struct {
	// The Content-Type for encoding a specific property. Default value depends on the property type:
	// for `object` - `application/json`;
	// for `array` – the default is defined based on the inner type;
	// for all other cases the default is `application/octet-stream`.
	//
	// The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types.
	ContentType string `json:"contentType,omitempty" yaml:"contentType,omitempty"`
	// A map allowing additional information to be provided as headers, for example `Content-Disposition`.
	// `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`.
	Headers Headers `json:"headers,omitempty" yaml:"headers,omitempty"`
	// Describes how a specific property value will be serialized depending on its type.
	// See Parameter Object for details on the `style` property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
	Style ParameterStyle `json:"style,omitempty" yaml:"style,omitempty"`
	// When this is true, property values of type `array` or `object` generate separate parameters for each value of the array, or key-value-pair of the map.
	// For other types of properties this property has no effect. When `style` is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
	Explode bool `json:"explode,omitzero" yaml:"explode,omitzero"`
	// Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of `contentType` (implicit or explicit) SHALL be ignored.
	AllowReserved bool `json:"allowReserved,omitzero" yaml:"allowReserved,omitzero"`
	// This object MAY be extended with Specification Extensions.
	Extensions Extensions `json:",inline" yaml:",inline"`

	// an index to the original location of this object
	idx int
}

func getIndexEncoding(mt *Encoding) int                { return mt.idx }
func setIndexEncoding(mt *Encoding, idx int) *Encoding { mt.idx = idx; return mt }

func (e *Encoding) Validate() error {
	if err := e.Headers.Validate(); err != nil {
		return &errpath.ErrField{Field: "headers", Err: err}
	}

	if e.Style != "" {
		if err := e.Style.Validate(); err != nil {
			return &errpath.ErrField{Field: "style", Err: err}
		}
	}

	return validateExtensions(e.Extensions)
}