Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct {
Target string `json:"target,omitempty" yaml:"target,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Update *yaml.Node `json:"update,omitempty" yaml:"update,omitempty"`
Remove bool `json:"remove,omitempty" yaml:"remove,omitempty"`
Copy string `json:"copy,omitempty" yaml:"copy,omitempty"`
Extensions *orderedmap.Map[string, *yaml.Node] `json:"-" yaml:"-"`
// contains filtered or unexported fields
}
Action represents a high-level Overlay Action Object. https://spec.openapis.org/overlay/v1.1.0#action-object
func (*Action) GoLow ¶
GoLow returns the low-level Action instance used to create the high-level one.
func (*Action) GoLowUntyped ¶
GoLowUntyped returns the low-level Action instance with no type.
func (*Action) MarshalYAML ¶
MarshalYAML creates a ready to render YAML representation of the Action object.
type Info ¶
type Info struct {
Title string `json:"title,omitempty" yaml:"title,omitempty"`
Version string `json:"version,omitempty" yaml:"version,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Extensions *orderedmap.Map[string, *yaml.Node] `json:"-" yaml:"-"`
// contains filtered or unexported fields
}
Info represents a high-level Overlay Info Object. https://spec.openapis.org/overlay/v1.1.0#info-object
func (*Info) GoLowUntyped ¶
GoLowUntyped returns the low-level Info instance with no type.
func (*Info) MarshalYAML ¶
MarshalYAML creates a ready to render YAML representation of the Info object.
type Overlay ¶
type Overlay struct {
Overlay string `json:"overlay,omitempty" yaml:"overlay,omitempty"`
Info *Info `json:"info,omitempty" yaml:"info,omitempty"`
Extends string `json:"extends,omitempty" yaml:"extends,omitempty"`
Actions []*Action `json:"actions,omitempty" yaml:"actions,omitempty"`
Extensions *orderedmap.Map[string, *yaml.Node] `json:"-" yaml:"-"`
// contains filtered or unexported fields
}
Overlay represents a high-level OpenAPI Overlay document. https://spec.openapis.org/overlay/v1.0.0
func NewOverlay ¶
NewOverlay creates a new high-level Overlay instance from a low-level one.
func (*Overlay) GoLow ¶
GoLow returns the low-level Overlay instance used to create the high-level one.
func (*Overlay) GoLowUntyped ¶
GoLowUntyped returns the low-level Overlay instance with no type.
func (*Overlay) MarshalYAML ¶
MarshalYAML creates a ready to render YAML representation of the Overlay object.
Source Files