Files
libopenapi/datamodel/low/low.go
Dave Shanley 65b242b6c4 Building out low level docs now
a long road ahead, but we must push forward.
2022-09-20 07:55:19 -04:00

15 lines
883 B
Go

// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT
// Package low contains a set of low-level models that represent OpenAPI 2 and 3 documents.
// These low-level models (plumbing) are used to create high-level models, and used when deep knowledge
// about the original data, positions, comments and the original node structures.
//
// Low-level models are not designed to be easily navigated, every single property is either a NodeReference
// an KeyReference or a ValueReference. These references hold the raw value and key or value nodes that contain
// the original yaml.Node trees that make up the object.
//
// Navigating maps that use a KeyReference as a key is tricky, because there is no easy way to provide a lookup.
// Convenience methods for lookup up properties in a low-level model have therefore been provided.
package low