openapibundle

package

v0.1.0 Latest Latest Go to latest Published: Oct 19, 2026 License: MIT Imports: 8 Imported by: 0

Details

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

Repository

github.com/weaveplatform/artifactweave

Links

Open Source Insights

Documentation ¶

Overview ¶

Package openapibundle merges the per-family spec fragments under api/src/<service>/ into the one document oapi-codegen and the parity test read. Authors edit fragments so several families can be written in parallel without one enormous file; the bundle is generated and committed so a reader of api/<service>.openapi.yaml sees the whole surface.

Index ¶

Constants
func Bundle(srcDir string) ([]byte, error)
func BundleAll(srcRoot, outDir string) ([]string, error)

Constants ¶

View Source

const InfoFile = "info.yaml"

InfoFile holds the document head: openapi, info, servers, tags, security.

Variables ¶

This section is empty.

Functions ¶

func Bundle ¶

func Bundle(srcDir string) ([]byte, error)

Bundle reads srcDir and returns the merged document as YAML. Keys inside paths and each components section are sorted so the output is stable regardless of which fragment a path came from.

func BundleAll ¶

func BundleAll(srcRoot, outDir string) ([]string, error)

BundleAll bundles every service directory under srcRoot into <outDir>/<service>.openapi.yaml and returns the services written.

Types ¶

This section is empty.

Source Files ¶

View all Source files

bundle.go

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