package openapi3

import "github.com/gohugoio/hugo/tpl/openapi/openapi3"

Package openapi3 provides functions for generating OpenAPI v3 (Swagger) documentation.

Index ¶

• type Namespace
• func New(deps *deps.Deps) *Namespace
• func (ns *Namespace) Unmarshal(ctx context.Context, args ...any) (*OpenAPIDocument, error)
• type OpenAPIDocument
• func (o *OpenAPIDocument) GetIdentityGroup() identity.Identity

Types ¶

type Namespace ¶

type Namespace struct {
	// contains filtered or unexported fields
}

Namespace provides template functions for the "openapi3".

func New ¶

func New(deps *deps.Deps) *Namespace

New returns a new instance of the openapi3-namespaced template functions.

func (*Namespace) Unmarshal ¶

func (ns *Namespace) Unmarshal(ctx context.Context, args ...any) (*OpenAPIDocument, error)

Unmarshal unmarshals the given resource into an OpenAPI 3 document.

type OpenAPIDocument ¶

type OpenAPIDocument struct {
	*kopenapi3.T
	// contains filtered or unexported fields
}

OpenAPIDocument represents an OpenAPI 3 document.

func (*OpenAPIDocument) GetIdentityGroup ¶

func (o *OpenAPIDocument) GetIdentityGroup() identity.Identity

Source Files ¶

init.go openapi3.go