bundle

Documentation

Overview

Package bundle turns a spec split over files and URLs into one document.

Index

• Variables
• func IsURL(loc string) bool
• func Run(ctx context.Context, in Input) (bool, []diag.Diagnostic, error)
• type Input
• type Loader

Variables

var (
	ErrLoad     = errors.New("load referenced file")
	ErrTarget   = errors.New("ref target not found")
	ErrFragment = errors.New("ref fragment is not a JSON pointer")
	ErrCycle    = errors.New("ref cycle")
	ErrInline   = errors.New("inlined ref target is not an object")
)

Functions

func IsURL

func IsURL(loc string) bool

IsURL reports whether a spec location is fetched over HTTP rather than read from disk.

func Run

func Run(ctx context.Context, in Input) (bool, []diag.Diagnostic, error)

Run lifts what the root's refs point at in other files into its components, in place, and inlines path items. It reports whether the document changed.

Types

type Input

type Input struct {
	Doc      *oasdoc.Doc
	Location string
	BaseDir  string
	Load     Loader
}

Input is the root spec. Its refs resolve against BaseDir when set, else next to Location.

type Loader

type Loader func(ctx context.Context, location string) ([]byte, error)

Loader reads a file path or URL.