openapi

Documentation

Index

• func Print(data map[string]interface{}, opts OutputOptions) error
• func RefreshServiceDescs(root *cobra.Command)
• func RegisterCommands(root *cobra.Command)
• type Invoker
  • func NewInvoker(profile *config.Profile, api *meta.Api, params map[string]string, ...) (*Invoker, error)
  • func (inv *Invoker) Call() (map[string]interface{}, error)
• type OutputFormat
• type OutputOptions

Functions

func Print

func Print(data map[string]interface{}, opts OutputOptions) error

Print applies --query then rows= (if set) and renders the result.

func RefreshServiceDescs

func RefreshServiceDescs(root *cobra.Command)

RefreshServiceDescs updates the Short description of every dynamically-registered API command to match the current language. Called from SetHelpFunc when --language overrides the active language at help-render time.

func RegisterCommands

func RegisterCommands(root *cobra.Command)

RegisterCommands dynamically adds one cobra.Command per service (from products.json), each with sub-commands for every API action found across all module JSON files.

Types

type Invoker

type Invoker struct {
	// contains filtered or unexported fields
}

Invoker executes a single BCE API call.

func NewInvoker

func NewInvoker(
	profile *config.Profile,
	api *meta.Api,
	params map[string]string,
	overrides *config.FlagOverrides,
	product *meta.Product,
) (*Invoker, error)

NewInvoker creates an Invoker, resolving the endpoint from overrides > profile > product metadata.

func (*Invoker) Call

func (inv *Invoker) Call() (map[string]interface{}, error)

Call executes the API request and returns the parsed JSON response.

type OutputFormat

type OutputFormat string

const (
	FormatJSON  OutputFormat = "json"
	FormatTable OutputFormat = "table"
	FormatText  OutputFormat = "text"
)

type OutputOptions

type OutputOptions struct {
	Format  OutputFormat
	Query   string   // --query: JMESPath applied first to the raw response
	Rows    string   // rows=: JMESPath applied after Query for table row extraction
	Cols    []string // column names for table output
	NoColor bool
}

OutputOptions configures response rendering.