Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Spec ¶
type Spec struct {
BaseURL string `json:"base_url,omitempty" yaml:"base_url,omitempty"`
Endpoint string `json:"endpoint" yaml:"endpoint"`
Method string `json:"method" yaml:"method"`
Headers map[string]string `json:"headers,omitempty" yaml:"headers,omitempty"`
PathParams provider.ParameterSet `json:"path_params,omitempty" yaml:"path_params,omitempty"`
QueryParams provider.ParameterSet `json:"query_params,omitempty" yaml:"query_params,omitempty"`
HeaderParams provider.ParameterSet `json:"header_params,omitempty" yaml:"header_params,omitempty"`
BodyParams provider.ParameterSet `json:"body_params,omitempty" yaml:"body_params,omitempty"`
RawBody bool `json:"raw_body,omitempty" yaml:"raw_body,omitempty"`
Body []form.Field `json:"body,omitempty" yaml:"body,omitempty"`
PrintStatus bool `json:"print_status,omitempty" yaml:"print_status,omitempty"`
}
Spec describes the provider.
func (*Spec) Configure ¶ added in v0.5.0
Configure wires up the command's positional arguments, flags, and run behavior.
Path parameters are positional (and substituted into the endpoint); query, header, and body-field parameters are flags. When RawBody is set, the request body comes from a --body flag (inline JSON or @file) instead of body fields.
func (*Spec) Execute ¶ added in v0.8.0
Execute assigns the interactively-collected values, performs the request, and returns a structured result for display.
func (*Spec) Sections ¶ added in v0.8.0
Sections describes the request's inputs for interactive entry: path, query, and header parameters, plus a body section (discrete fields, flat body params, or a single raw-text block depending on how the command is defined).
Source Files
Click to show internal directories.
Click to hide internal directories.