libopenapi/datamodel/high/v2/definitions.go

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

package v2

import (
	highbase "github.com/pb33f/libopenapi/datamodel/high/base"
	lowmodel "github.com/pb33f/libopenapi/datamodel/low"
	lowbase "github.com/pb33f/libopenapi/datamodel/low/base"
	low "github.com/pb33f/libopenapi/datamodel/low/v2"
	"github.com/pb33f/libopenapi/orderedmap"
)

// Definitions is a high-level represents of a Swagger / OpenAPI 2 Definitions object, backed by a low-level one.
//
// An object to hold data types that can be consumed and produced by operations. These data types can be primitives,
// arrays or models.
//   - https://swagger.io/specification/v2/#definitionsObject
type Definitions struct {
	Definitions orderedmap.Map[string, *highbase.SchemaProxy]
	low         *low.Definitions
}

// NewDefinitions will create a new high-level instance of a Definition from a low-level one.
func NewDefinitions(definitions *low.Definitions) *Definitions {
	rd := new(Definitions)
	rd.low = definitions
	defs := orderedmap.New[string, *highbase.SchemaProxy]()
	translateFunc := func(pair orderedmap.Pair[lowmodel.KeyReference[string], lowmodel.ValueReference[*lowbase.SchemaProxy]]) (asyncResult[*highbase.SchemaProxy], error) {
		return asyncResult[*highbase.SchemaProxy]{
			key:    pair.Key().Value,
			result: highbase.NewSchemaProxy(&lowmodel.NodeReference[*lowbase.SchemaProxy]{
				Value: pair.Value().Value,
			}),
		}, nil
	}
	resultFunc := func(value asyncResult[*highbase.SchemaProxy]) error {
		defs.Set(value.key, value.result)
		return nil
	}
	_ = orderedmap.TranslateMapParallel(definitions.Schemas, translateFunc, resultFunc)
	rd.Definitions = defs
	return rd
}

// GoLow returns the low-level Definitions object used to create the high-level one.
func (d *Definitions) GoLow() *low.Definitions {
	return d.low
}