request

package

v0.28.1 Latest Latest Go to latest Published: Apr 17, 2026 License: Apache-2.0 Imports: 41 Imported by: 0

Details

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

Repository

github.com/unkn0wn-root/resterm

Links

Documentation ¶

Index ¶

func AuthSecretValues(auth *restfile.AuthSpec, res *vars.Resolver) []string
func CloneRequest(req *restfile.Request) *restfile.Request
func CommandAuthSecrets(res authcmd.Result) []string
func InjectedAuthSecrets(auth *restfile.AuthSpec, before *restfile.Request, after *restfile.Request) []string
func RenderRequestText(req *restfile.Request) string
type Engine
- func New(cfg engine.Config, rt *rtrun.Runtime) *Engine
type ExecMode
type ExecOptions
type ExplainAuthPreviewResult
type ForEachSpec

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AuthSecretValues ¶ added in v0.27.2

func AuthSecretValues(auth *restfile.AuthSpec, res *vars.Resolver) []string

func CloneRequest ¶

func CloneRequest(req *restfile.Request) *restfile.Request

func CommandAuthSecrets ¶ added in v0.27.2

func CommandAuthSecrets(res authcmd.Result) []string

func InjectedAuthSecrets ¶ added in v0.27.2

func InjectedAuthSecrets(
	auth *restfile.AuthSpec,
	before *restfile.Request,
	after *restfile.Request,
) []string

func RenderRequestText ¶

func RenderRequestText(req *restfile.Request) string

Types ¶

type Engine ¶

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

func New ¶

func New(cfg engine.Config, rt *rtrun.Runtime) *Engine

func (*Engine) BuildCommandAuthConfig ¶ added in v0.27.2

func (e *Engine) BuildCommandAuthConfig(
	doc *restfile.Document,
	auth *restfile.AuthSpec,
	res *vars.Resolver,
	timeout time.Duration,
) (authcmd.Config, error)

func (*Engine) BuildOAuthConfig ¶ added in v0.27.2

func (e *Engine) BuildOAuthConfig(
	auth *restfile.AuthSpec,
	res *vars.Resolver,
) (oauth.Config, error)

func (*Engine) CollectVariables ¶

func (e *Engine) CollectVariables(
	doc *restfile.Document,
	req *restfile.Request,
	env string,
	extras ...map[string]string,
) map[string]string

func (*Engine) EnsureCommandAuth ¶ added in v0.27.2

func (e *Engine) EnsureCommandAuth(
	ctx context.Context,
	doc *restfile.Document,
	req *restfile.Request,
	res *vars.Resolver,
	env string,
	timeout time.Duration,
) (authcmd.Result, error)

func (*Engine) EnsureOAuth ¶ added in v0.27.2

func (e *Engine) EnsureOAuth(
	ctx context.Context,
	req *restfile.Request,
	res *vars.Resolver,
	opts httpclient.Options,
	env string,
	timeout time.Duration,
) error

func (*Engine) EvalCondition ¶

func (e *Engine) EvalCondition(
	ctx context.Context,
	doc *restfile.Document,
	req *restfile.Request,
	env, base string,
	spec *restfile.ConditionSpec,
	vv map[string]string,
	extra map[string]rts.Value,
) (bool, string, error)

func (*Engine) EvalForEachItems ¶

func (e *Engine) EvalForEachItems(
	ctx context.Context,
	doc *restfile.Document,
	req *restfile.Request,
	env, base string,
	spec ForEachSpec,
	vv map[string]string,
	extra map[string]rts.Value,
) ([]rts.Value, error)

func (*Engine) EvalValue ¶

func (e *Engine) EvalValue(
	ctx context.Context,
	doc *restfile.Document,
	req *restfile.Request,
	env, base, expr, site string,
	pos rts.Pos,
	vv map[string]string,
	extra map[string]rts.Value,
) (rts.Value, error)

func (*Engine) Execute ¶

func (e *Engine) Execute(
	doc *restfile.Document,
	req *restfile.Request,
	env string,
) (engine.RequestResult, error)

func (*Engine) ExecuteWith ¶

func (e *Engine) ExecuteWith(
	doc *restfile.Document,
	req *restfile.Request,
	env string,
	opt ExecOptions,
) (engine.RequestResult, error)

func (*Engine) PosForLine ¶

func (e *Engine) PosForLine(doc *restfile.Document, req *restfile.Request, line int) rts.Pos

func (*Engine) PrepareCommandAuth ¶ added in v0.27.2

func (e *Engine) PrepareCommandAuth(
	doc *restfile.Document,
	auth *restfile.AuthSpec,
	res *vars.Resolver,
	env string,
	timeout time.Duration,
) (authcmd.Prepared, error)

func (*Engine) PrepareExplainAuthPreview ¶ added in v0.27.2

func (e *Engine) PrepareExplainAuthPreview(
	doc *restfile.Document,
	req *restfile.Request,
	res *vars.Resolver,
	env string,
) (ExplainAuthPreviewResult, error)

func (*Engine) ResolveInheritedAuth ¶ added in v0.27.2

func (e *Engine) ResolveInheritedAuth(doc *restfile.Document, req *restfile.Request)

func (*Engine) ResolveOAuthConfig ¶ added in v0.27.2

func (e *Engine) ResolveOAuthConfig(
	auth *restfile.AuthSpec,
	res *vars.Resolver,
	env string,
) (oauth.Config, error)

func (*Engine) SetConfig ¶

func (e *Engine) SetConfig(cfg engine.Config)

func (*Engine) ValueString ¶

func (e *Engine) ValueString(ctx context.Context, pos rts.Pos, v rts.Value) (string, error)

type ExecMode ¶

type ExecMode uint8

const (
	ExecModeSend ExecMode = iota
	ExecModePreview
)

type ExecOptions ¶

type ExecOptions struct {
	Extra      map[string]string
	Values     map[string]rts.Value
	Record     bool
	Ctx        context.Context
	Mode       ExecMode
	AttachSSE  func(*httpclient.StreamHandle, *restfile.Request)
	AttachWS   func(*httpclient.WebSocketHandle, *restfile.Request)
	AttachGRPC func(*stream.Session, *restfile.Request)
	Release    func()
}

type ExplainAuthPreviewResult ¶ added in v0.27.2

type ExplainAuthPreviewResult struct {
	Status       xplain.StageStatus
	Summary      string
	Notes        []string
	ExtraSecrets []string
}

type ForEachSpec ¶

type ForEachSpec struct {
	Expr string
	Var  string
	Line int
}

Source Files ¶

View all Source files

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