mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 20:47:49 +00:00
111 lines
3.3 KiB
Go
111 lines
3.3 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package v3
|
|
|
|
import (
|
|
"github.com/pb33f/libopenapi/datamodel/low"
|
|
"github.com/pb33f/libopenapi/datamodel/low/base"
|
|
"github.com/pb33f/libopenapi/index"
|
|
"gopkg.in/yaml.v3"
|
|
)
|
|
|
|
// Operation is a low-level representation of an OpenAPI 3+ Operation object.
|
|
//
|
|
// An Operation is perhaps the most important object of the entire specification. Everything of value
|
|
// happens here. The entire being for existence of this library and the specification, is this Operation.
|
|
// - https://spec.openapis.org/oas/v3.1.0#operation-object
|
|
type Operation struct {
|
|
Tags low.NodeReference[[]low.ValueReference[string]]
|
|
Summary low.NodeReference[string]
|
|
Description low.NodeReference[string]
|
|
ExternalDocs low.NodeReference[*base.ExternalDoc]
|
|
OperationId low.NodeReference[string]
|
|
Parameters low.NodeReference[[]low.ValueReference[*Parameter]]
|
|
RequestBody low.NodeReference[*RequestBody]
|
|
Responses low.NodeReference[*Responses]
|
|
Callbacks low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Callback]]
|
|
Deprecated low.NodeReference[bool]
|
|
Security low.NodeReference[*SecurityRequirement]
|
|
Servers low.NodeReference[[]low.ValueReference[*Server]]
|
|
Extensions map[low.KeyReference[string]]low.ValueReference[any]
|
|
}
|
|
|
|
// FindCallback will attempt to locate a Callback instance by the supplied name.
|
|
func (o *Operation) FindCallback(callback string) *low.ValueReference[*Callback] {
|
|
return low.FindItemInMap[*Callback](callback, o.Callbacks.Value)
|
|
}
|
|
|
|
// Build will extract external docs, parameters, request body, responses, callbacks, security and servers.
|
|
func (o *Operation) Build(root *yaml.Node, idx *index.SpecIndex) error {
|
|
o.Extensions = low.ExtractExtensions(root)
|
|
|
|
// extract externalDocs
|
|
extDocs, dErr := low.ExtractObject[*base.ExternalDoc](base.ExternalDocsLabel, root, idx)
|
|
if dErr != nil {
|
|
return dErr
|
|
}
|
|
o.ExternalDocs = extDocs
|
|
|
|
// extract parameters
|
|
params, ln, vn, pErr := low.ExtractArray[*Parameter](ParametersLabel, root, idx)
|
|
if pErr != nil {
|
|
return pErr
|
|
}
|
|
if params != nil {
|
|
o.Parameters = low.NodeReference[[]low.ValueReference[*Parameter]]{
|
|
Value: params,
|
|
KeyNode: ln,
|
|
ValueNode: vn,
|
|
}
|
|
}
|
|
|
|
// extract request body
|
|
rBody, rErr := low.ExtractObject[*RequestBody](RequestBodyLabel, root, idx)
|
|
if rErr != nil {
|
|
return rErr
|
|
}
|
|
o.RequestBody = rBody
|
|
|
|
// extract responses
|
|
respBody, respErr := low.ExtractObject[*Responses](ResponsesLabel, root, idx)
|
|
if respErr != nil {
|
|
return respErr
|
|
}
|
|
o.Responses = respBody
|
|
|
|
// extract callbacks
|
|
callbacks, cbL, cbN, cbErr := low.ExtractMap[*Callback](CallbacksLabel, root, idx)
|
|
if cbErr != nil {
|
|
return cbErr
|
|
}
|
|
if callbacks != nil {
|
|
o.Callbacks = low.NodeReference[map[low.KeyReference[string]]low.ValueReference[*Callback]]{
|
|
Value: callbacks,
|
|
KeyNode: cbL,
|
|
ValueNode: cbN,
|
|
}
|
|
}
|
|
|
|
// extract security
|
|
sec, sErr := low.ExtractObject[*SecurityRequirement](SecurityLabel, root, idx)
|
|
if sErr != nil {
|
|
return sErr
|
|
}
|
|
o.Security = sec
|
|
|
|
// extract servers
|
|
servers, sl, sn, serErr := low.ExtractArray[*Server](ServersLabel, root, idx)
|
|
if serErr != nil {
|
|
return serErr
|
|
}
|
|
if servers != nil {
|
|
o.Servers = low.NodeReference[[]low.ValueReference[*Server]]{
|
|
Value: servers,
|
|
KeyNode: sl,
|
|
ValueNode: sn,
|
|
}
|
|
}
|
|
return nil
|
|
}
|