mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 04:20:11 +00:00
80 lines
2.7 KiB
Go
80 lines
2.7 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package v3
|
|
|
|
import (
|
|
"github.com/pb33f/libopenapi/datamodel/high"
|
|
low "github.com/pb33f/libopenapi/datamodel/low/v3"
|
|
"github.com/pb33f/libopenapi/orderedmap"
|
|
"gopkg.in/yaml.v3"
|
|
)
|
|
|
|
// Response represents a high-level OpenAPI 3+ Response object that is backed by a low-level one.
|
|
//
|
|
// Describes a single response from an API Operation, including design-time, static links to
|
|
// operations based on the response.
|
|
// - https://spec.openapis.org/oas/v3.1.0#response-object
|
|
type Response struct {
|
|
Description string `json:"description,omitempty" yaml:"description,omitempty"`
|
|
Headers orderedmap.Map[string, *Header] `json:"headers,omitempty" yaml:"headers,omitempty"`
|
|
Content orderedmap.Map[string, *MediaType] `json:"content,omitempty" yaml:"content,omitempty"`
|
|
Links orderedmap.Map[string, *Link] `json:"links,omitempty" yaml:"links,omitempty"`
|
|
Extensions map[string]any `json:"-" yaml:"-"`
|
|
low *low.Response
|
|
}
|
|
|
|
// NewResponse creates a new high-level Response object that is backed by a low-level one.
|
|
func NewResponse(response *low.Response) *Response {
|
|
r := new(Response)
|
|
r.low = response
|
|
r.Description = response.Description.Value
|
|
if !response.Headers.IsEmpty() {
|
|
r.Headers = ExtractHeaders(response.Headers.Value)
|
|
}
|
|
r.Extensions = high.ExtractExtensions(response.Extensions)
|
|
if !response.Content.IsEmpty() {
|
|
r.Content = ExtractContent(response.Content.Value)
|
|
}
|
|
if !response.Links.IsEmpty() {
|
|
responseLinks := orderedmap.New[string, *Link]()
|
|
for pair := orderedmap.First(response.Links.Value); pair != nil; pair = pair.Next() {
|
|
responseLinks.Set(pair.Key().Value, NewLink(pair.Value().Value))
|
|
}
|
|
r.Links = responseLinks
|
|
}
|
|
return r
|
|
}
|
|
|
|
// GoLow returns the low-level Response object that was used to create the high-level one.
|
|
func (r *Response) GoLow() *low.Response {
|
|
return r.low
|
|
}
|
|
|
|
// GoLowUntyped will return the low-level Response instance that was used to create the high-level one, with no type
|
|
func (r *Response) GoLowUntyped() any {
|
|
return r.low
|
|
}
|
|
|
|
// Render will return a YAML representation of the Response object as a byte slice.
|
|
func (r *Response) Render() ([]byte, error) {
|
|
return yaml.Marshal(r)
|
|
}
|
|
|
|
func (r *Response) RenderInline() ([]byte, error) {
|
|
d, _ := r.MarshalYAMLInline()
|
|
return yaml.Marshal(d)
|
|
}
|
|
|
|
// MarshalYAML will create a ready to render YAML representation of the Response object.
|
|
func (r *Response) MarshalYAML() (interface{}, error) {
|
|
nb := high.NewNodeBuilder(r, r.low)
|
|
return nb.Render(), nil
|
|
}
|
|
|
|
func (r *Response) MarshalYAMLInline() (interface{}, error) {
|
|
nb := high.NewNodeBuilder(r, r.low)
|
|
nb.Resolve = true
|
|
return nb.Render(), nil
|
|
}
|