]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
tpl/openapi3: Wrap *kopenapi3.T
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 13 Dec 2022 10:11:14 +0000 (11:11 +0100)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Wed, 14 Dec 2022 11:29:40 +0000 (12:29 +0100)
To make it easier to document.

tpl/openapi/openapi3/openapi3.go

index 1eea04b2562515d00532ba7adbe58cfa5aa9f698..9b84e9fbe47f144e01de87c5f23befca343e60b2 100644 (file)
@@ -49,7 +49,12 @@ type Namespace struct {
        deps  *deps.Deps
 }
 
-func (ns *Namespace) Unmarshal(r resource.UnmarshableResource) (*kopenapi3.T, error) {
+// OpenAPIDocument represents an OpenAPI 3 document.
+type OpenAPIDocument struct {
+       *kopenapi3.T
+}
+
+func (ns *Namespace) Unmarshal(r resource.UnmarshableResource) (*OpenAPIDocument, error) {
        key := r.Key()
        if key == "" {
                return nil, errors.New("no Key set in Resource")
@@ -85,11 +90,11 @@ func (ns *Namespace) Unmarshal(r resource.UnmarshableResource) (*kopenapi3.T, er
 
                err = kopenapi3.NewLoader().ResolveRefsIn(s, nil)
 
-               return s, err
+               return &OpenAPIDocument{T: s}, err
        })
        if err != nil {
                return nil, err
        }
 
-       return v.(*kopenapi3.T), nil
+       return v.(*OpenAPIDocument), nil
 }