spec

package

v0.0.1-rc5 Latest Latest Go to latest Published: Apr 28, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

Documentation ¶

Overview ¶

Package spec embeds api/openapi.yaml at build time and exposes both the raw YAML bytes and a parsed JSON tree for serving on GET /api/v1/openapi.json.

Index ¶

Variables
func AsRawMap() (map[string]jx.Raw, error)
func JSON() ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var YAML []byte

YAML is the raw OpenAPI document, embedded from api/openapi.yaml.

Functions ¶

func AsRawMap ¶

func AsRawMap() (map[string]jx.Raw, error)

AsRawMap returns the OpenAPI document as a map[string]jx.Raw, ready to be returned from the ogen-generated GetOpenAPIOK handler.

func JSON ¶

func JSON() ([]byte, error)

JSON returns the OpenAPI document re-encoded as JSON. The result is memoised; callers may share the byte slice freely.

Types ¶

This section is empty.

Source Files ¶

View all Source files

spec.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL