mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 04:20:11 +00:00
120 lines
4.0 KiB
Go
120 lines
4.0 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
||
// SPDX-License-Identifier: MIT
|
||
|
||
package v3
|
||
|
||
import (
|
||
"context"
|
||
"crypto/sha256"
|
||
"strings"
|
||
|
||
"github.com/pb33f/libopenapi/datamodel/low"
|
||
"github.com/pb33f/libopenapi/index"
|
||
"github.com/pb33f/libopenapi/orderedmap"
|
||
"github.com/pb33f/libopenapi/utils"
|
||
"gopkg.in/yaml.v3"
|
||
)
|
||
|
||
// Link represents a low-level OpenAPI 3+ Link object.
|
||
//
|
||
// The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the
|
||
// caller’s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between
|
||
// responses and other operations.
|
||
//
|
||
// Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require
|
||
// link information in the runtime response.
|
||
//
|
||
// For computing links, and providing instructions to execute them, a runtime expression is used for accessing values
|
||
// in an operation and using them as parameters while invoking the linked operation.
|
||
// - https://spec.openapis.org/oas/v3.1.0#link-object
|
||
type Link struct {
|
||
OperationRef low.NodeReference[string]
|
||
OperationId low.NodeReference[string]
|
||
Parameters low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[string]]]
|
||
RequestBody low.NodeReference[string]
|
||
Description low.NodeReference[string]
|
||
Server low.NodeReference[*Server]
|
||
Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]]
|
||
KeyNode *yaml.Node
|
||
RootNode *yaml.Node
|
||
*low.Reference
|
||
low.NodeMap
|
||
}
|
||
|
||
// GetExtensions returns all Link extensions and satisfies the low.HasExtensions interface.
|
||
func (l *Link) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] {
|
||
return l.Extensions
|
||
}
|
||
|
||
// FindParameter will attempt to locate a parameter string value, using a parameter name input.
|
||
func (l *Link) FindParameter(pName string) *low.ValueReference[string] {
|
||
return low.FindItemInOrderedMap[string](pName, l.Parameters.Value)
|
||
}
|
||
|
||
// FindExtension will attempt to locate an extension with a specific key
|
||
func (l *Link) FindExtension(ext string) *low.ValueReference[*yaml.Node] {
|
||
return low.FindItemInOrderedMap(ext, l.Extensions)
|
||
}
|
||
|
||
// GetRootNode returns the root yaml node of the Link object
|
||
func (l *Link) GetRootNode() *yaml.Node {
|
||
return l.RootNode
|
||
}
|
||
|
||
// GetKeyNode returns the key yaml node of the Link object
|
||
func (l *Link) GetKeyNode() *yaml.Node {
|
||
return l.KeyNode
|
||
}
|
||
|
||
// Build will extract extensions and servers from the node.
|
||
func (l *Link) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
|
||
l.KeyNode = keyNode
|
||
root = utils.NodeAlias(root)
|
||
l.RootNode = root
|
||
utils.CheckForMergeNodes(root)
|
||
l.Reference = new(low.Reference)
|
||
l.Nodes = low.ExtractNodes(ctx, root)
|
||
l.Extensions = low.ExtractExtensions(root)
|
||
low.ExtractExtensionNodes(ctx, l.Extensions, l.Nodes)
|
||
|
||
// extract parameter nodes.
|
||
if l.Parameters.Value != nil && l.Parameters.Value.Len() > 0 {
|
||
for fk := l.Parameters.Value.First(); fk != nil; fk = fk.Next() {
|
||
l.Nodes.Store(fk.Key().KeyNode.Line, fk.Key().KeyNode)
|
||
}
|
||
}
|
||
|
||
// extract server.
|
||
ser, sErr := low.ExtractObject[*Server](ctx, ServerLabel, root, idx)
|
||
if sErr != nil {
|
||
return sErr
|
||
}
|
||
l.Server = ser
|
||
return nil
|
||
}
|
||
|
||
// Hash will return a consistent SHA256 Hash of the Link object
|
||
func (l *Link) Hash() [32]byte {
|
||
var f []string
|
||
if l.Description.Value != "" {
|
||
f = append(f, l.Description.Value)
|
||
}
|
||
if l.OperationRef.Value != "" {
|
||
f = append(f, l.OperationRef.Value)
|
||
}
|
||
if l.OperationId.Value != "" {
|
||
f = append(f, l.OperationId.Value)
|
||
}
|
||
if l.RequestBody.Value != "" {
|
||
f = append(f, l.RequestBody.Value)
|
||
}
|
||
if l.Server.Value != nil {
|
||
f = append(f, low.GenerateHashString(l.Server.Value))
|
||
}
|
||
for pair := orderedmap.First(orderedmap.SortAlpha(l.Parameters.Value)); pair != nil; pair = pair.Next() {
|
||
f = append(f, pair.Value().Value)
|
||
}
|
||
f = append(f, low.HashExtensions(l.Extensions)...)
|
||
return sha256.Sum256([]byte(strings.Join(f, "|")))
|
||
}
|