Files
libopenapi/datamodel/low/v3/request_body.go
2024-08-26 20:42:40 +01:00

102 lines
3.2 KiB
Go

// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT
package v3
import (
"context"
"crypto/sha256"
"fmt"
"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"
)
// RequestBody represents a low-level OpenAPI 3+ RequestBody object.
// - https://spec.openapis.org/oas/v3.1.0#request-body-object
type RequestBody struct {
Description low.NodeReference[string]
Content low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*MediaType]]]
Required low.NodeReference[bool]
Extensions *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]]
KeyNode *yaml.Node
RootNode *yaml.Node
*low.Reference
low.NodeMap
}
// GetRootNode returns the root yaml node of the RequestBody object.
func (rb *RequestBody) GetRootNode() *yaml.Node {
return rb.RootNode
}
// GetKeyNode returns the key yaml node of the RequestBody object.
func (rb *RequestBody) GetKeyNode() *yaml.Node {
return rb.KeyNode
}
// FindExtension attempts to locate an extension using the provided name.
func (rb *RequestBody) FindExtension(ext string) *low.ValueReference[*yaml.Node] {
return low.FindItemInOrderedMap(ext, rb.Extensions)
}
// GetExtensions returns all RequestBody extensions and satisfies the low.HasExtensions interface.
func (rb *RequestBody) GetExtensions() *orderedmap.Map[low.KeyReference[string], low.ValueReference[*yaml.Node]] {
return rb.Extensions
}
// FindContent attempts to find content/MediaType defined using a specified name.
func (rb *RequestBody) FindContent(cType string) *low.ValueReference[*MediaType] {
return low.FindItemInOrderedMap[*MediaType](cType, rb.Content.Value)
}
// Build will extract extensions and MediaType objects from the node.
func (rb *RequestBody) Build(ctx context.Context, keyNode, root *yaml.Node, idx *index.SpecIndex) error {
rb.KeyNode = keyNode
root = utils.NodeAlias(root)
rb.RootNode = root
utils.CheckForMergeNodes(root)
rb.Reference = new(low.Reference)
rb.Nodes = low.ExtractNodes(ctx, root)
rb.Extensions = low.ExtractExtensions(root)
low.ExtractExtensionNodes(ctx, rb.Extensions, rb.Nodes)
// handle content, if set.
con, cL, cN, cErr := low.ExtractMap[*MediaType](ctx, ContentLabel, root, idx)
if cErr != nil {
return cErr
}
if con != nil {
rb.Content = low.NodeReference[*orderedmap.Map[low.KeyReference[string], low.ValueReference[*MediaType]]]{
Value: con,
KeyNode: cL,
ValueNode: cN,
}
rb.Nodes.Store(cL.Line, cL)
for k, v := range con.FromOldest() {
v.Value.Nodes.Store(k.KeyNode.Line, k.KeyNode)
}
}
return nil
}
// Hash will return a consistent SHA256 Hash of the RequestBody object
func (rb *RequestBody) Hash() [32]byte {
var f []string
if rb.Description.Value != "" {
f = append(f, rb.Description.Value)
}
if !rb.Required.IsEmpty() {
f = append(f, fmt.Sprint(rb.Required.Value))
}
for v := range orderedmap.SortAlpha(rb.Content.Value).ValuesFromOldest() {
f = append(f, low.GenerateHashString(v.Value))
}
f = append(f, low.HashExtensions(rb.Extensions)...)
return sha256.Sum256([]byte(strings.Join(f, "|")))
}