apidocs

package

v0.3.0 Latest Latest Go to latest Published: Oct 2, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

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

Repository

github.com/meshcloud/meshstack-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package apidocs loads the OpenAPI document of the meshStack API into the config directory, and keeps it there up to date.

Index ¶

Variables
func Load(ctx context.Context, opts Options) (spec openapi.Spec, wait func(), err error)
type Options

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNoConfigDir = errors.New("no writable config directory to keep the API docs in")

ErrNoConfigDir is returned rather than a document downloaded for nothing, because 4.7MB per command is too much to fetch again and again.

Functions ¶

func Load ¶

func Load(ctx context.Context, opts Options) (spec openapi.Spec, wait func(), err error)

Load returns a wait that the caller runs when the command has done its work, so that a slow download can finish.

Types ¶

type Options ¶

type Options struct {
	setting.Sources

	UserAgent string
	// Version is the CLI's. A build of no release reads the docs of develop, as Dev does.
	Version string
	Dev     bool
}

Source Files ¶

View all Source files

apidocs.go

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