mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 12:37:49 +00:00
8717b3cd33
Every `Build()` method now requires a `context.Context`. This is so the rolodex knows where to resolve from when locating relative links. Without knowing where we are, there is no way to resolve anything. This new mechanism allows the model to recurse across as many files as required to locate references, without loosing track of where we are in the process. Signed-off-by: quobix <dave@quobix.com>
66 lines
2.0 KiB
Go
66 lines
2.0 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package base
|
|
|
|
import (
|
|
"context"
|
|
"crypto/sha256"
|
|
"fmt"
|
|
"github.com/pb33f/libopenapi/datamodel/low"
|
|
"github.com/pb33f/libopenapi/index"
|
|
"github.com/pb33f/libopenapi/utils"
|
|
"gopkg.in/yaml.v3"
|
|
"sort"
|
|
"strings"
|
|
)
|
|
|
|
// ExternalDoc represents a low-level External Documentation object as defined by OpenAPI 2 and 3
|
|
//
|
|
// Allows referencing an external resource for extended documentation.
|
|
//
|
|
// v2 - https://swagger.io/specification/v2/#externalDocumentationObject
|
|
// v3 - https://spec.openapis.org/oas/v3.1.0#external-documentation-object
|
|
type ExternalDoc struct {
|
|
Description low.NodeReference[string]
|
|
URL low.NodeReference[string]
|
|
Extensions map[low.KeyReference[string]]low.ValueReference[any]
|
|
*low.Reference
|
|
}
|
|
|
|
// FindExtension returns a ValueReference containing the extension value, if found.
|
|
func (ex *ExternalDoc) FindExtension(ext string) *low.ValueReference[any] {
|
|
return low.FindItemInMap[any](ext, ex.Extensions)
|
|
}
|
|
|
|
// Build will extract extensions from the ExternalDoc instance.
|
|
func (ex *ExternalDoc) Build(_ context.Context, _, root *yaml.Node, idx *index.SpecIndex) error {
|
|
root = utils.NodeAlias(root)
|
|
utils.CheckForMergeNodes(root)
|
|
ex.Reference = new(low.Reference)
|
|
ex.Extensions = low.ExtractExtensions(root)
|
|
return nil
|
|
}
|
|
|
|
// GetExtensions returns all ExternalDoc extensions and satisfies the low.HasExtensions interface.
|
|
func (ex *ExternalDoc) GetExtensions() map[low.KeyReference[string]]low.ValueReference[any] {
|
|
return ex.Extensions
|
|
}
|
|
|
|
func (ex *ExternalDoc) Hash() [32]byte {
|
|
// calculate a hash from every property.
|
|
f := []string{
|
|
ex.Description.Value,
|
|
ex.URL.Value,
|
|
}
|
|
keys := make([]string, len(ex.Extensions))
|
|
z := 0
|
|
for k := range ex.Extensions {
|
|
keys[z] = fmt.Sprintf("%s-%x", k.Value, sha256.Sum256([]byte(fmt.Sprint(ex.Extensions[k].Value))))
|
|
z++
|
|
}
|
|
sort.Strings(keys)
|
|
f = append(f, keys...)
|
|
return sha256.Sum256([]byte(strings.Join(f, "|")))
|
|
}
|