openapi

Documentation

Index

• Constants
• func GenExample(schema *base.Schema, mode schemaMode) interface{}
• func New() cli.Loader
• type Resolver

Constants

const (
	// Change the CLI name for an operation or parameter
	ExtName = "x-cli-name"

	// Set additional command aliases for an operation
	ExtAliases = "x-cli-aliases"

	// Change the description of an operation or parameter
	ExtDescription = "x-cli-description"

	// Ignore a path, operation, or parameter
	ExtIgnore = "x-cli-ignore"

	// Create a hidden command for an operation. It will not show in the help,
	// but can still be called.
	ExtHidden = "x-cli-hidden"

	// Custom auto-configuration for CLIs
	ExtCLIConfig = "x-cli-config"
)

OpenAPI Extensions

Functions

func GenExample

func GenExample(schema *base.Schema, mode schemaMode) interface{}

GenExample creates a dummy example from a given schema.

func New

func New() cli.Loader

New creates a new OpenAPI loader.

Types

type Resolver

type Resolver interface {
	GetBase() *url.URL
	Resolve(uri string) (*url.URL, error)
}

Resolver is able to resolve relative URIs against a base.