spec

package
v0.0.1-rc3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 27, 2026 License: MIT Imports: 6 Imported by: 0

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

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.

Jump to

Keyboard shortcuts

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