openapi

package
v0.3.12 Latest Latest
Warning

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

Go to latest
Published: Jul 2, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package openapi emits an OpenAPI 3.0 spec for a TinyRaven deployment from the live pipe registry (ADR 0017). It only ever marshals a fixed, known shape — a static /v0 base plus one path per published endpoint pipe — so it owns a minimal set of OpenAPI-3 structs and uses stdlib encoding/json; it never parses or validates third-party specs, so kin-openapi is intentionally not a dependency (ADR 0032).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Generate

func Generate(pipes []*model.Pipe) []byte

Generate returns the OpenAPI 3.0 JSON describing the frozen /v0 surface plus a GET /v0/pipes/{name}.json path for every endpoint pipe, with each pipe's {{Type(name)}} template params rendered as typed query parameters (ADR 0017). The /v0 surface is frozen and the native extension surface is namespaced (ADR 0029).

Types

This section is empty.

Jump to

Keyboard shortcuts

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