explain

package
v0.28.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source
const (
	StageApply            = "@apply"
	StageCondition        = "condition"
	StageRoute            = "route"
	StageSettings         = "settings"
	StageAuth             = "auth"
	StageRTSPreRequest    = "rts pre-request"
	StageJSPreRequest     = "js pre-request"
	StageGRPCPrepare      = "grpc prepare"
	StageHTTPPrepare      = "http prepare"
	StageWebSocketPrepare = "websocket prepare"
	StageCaptures         = "captures"
)
View Source
const (
	RouteKindDirect = "direct"
	RouteKindSSH    = "ssh"
	RouteKindK8s    = "k8s"
)
View Source
const (
	SummaryApplyComplete               = "apply complete"
	SummaryApplyFailed                 = "apply failed"
	SummaryConditionPassed             = "condition passed"
	SummaryConditionBlockedRequest     = "condition blocked request"
	SummaryConditionEvaluationFailed   = "condition evaluation failed"
	SummaryRouteSSHResolutionFailed    = "ssh resolution failed"
	SummaryRouteK8sResolutionFailed    = "k8s resolution failed"
	SummaryRouteConfigInvalid          = "route configuration invalid"
	SummarySettingsMerged              = "effective settings merged"
	SummarySettingsApplyFailed         = "settings application failed"
	SummaryAuthPrepared                = "auth prepared"
	SummaryAuthInjectionFailed         = "auth injection failed"
	SummaryOAuthTokenFetchSkipped      = "oauth token fetch skipped"
	SummaryCommandAuthExecutionSkipped = "command auth execution skipped"
	SummaryAuthTypeNotApplied          = "auth type not applied"
	SummaryRTSPreRequestComplete       = "RTS pre-request complete"
	SummaryRTSPreRequestFailed         = "RTS pre-request failed"
	SummaryRTSPreRequestOutputBad      = "RTS pre-request output invalid"
	SummaryJSPreRequestComplete        = "JS pre-request complete"
	SummaryJSPreRequestFailed          = "JS pre-request failed"
	SummaryJSPreRequestOutputBad       = "JS pre-request output invalid"
	SummaryGRPCRequestPrepared         = "gRPC request prepared"
	SummaryGRPCPrepareFailed           = "gRPC preparation failed"
	SummaryHTTPRequestPrepared         = "HTTP request prepared"
	SummaryHTTPRequestBuildFailed      = "HTTP request build failed"
	SummaryWebSocketRequestPrepared    = "WebSocket request prepared"
	SummaryWebSocketPrepareFailed      = "WebSocket preparation failed"
	SummaryCaptureEvaluationFailed     = "capture evaluation failed"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Change

type Change struct {
	Field  string
	Before string
	After  string
}

type Final

type Final struct {
	Mode     string
	Protocol string
	Method   string
	URL      string
	Headers  []Header
	Body     string
	BodyNote string
	Settings []Pair
	Route    *Route
	Details  []Pair
	Steps    []string
}
type Header struct {
	Name  string
	Value string
}

type Pair

type Pair struct {
	Key   string
	Value string
}

type Report

type Report struct {
	Name     string
	Method   string
	URL      string
	Env      string
	Status   Status
	Decision string
	Failure  string
	Vars     []Var
	Stages   []Stage
	Final    *Final
	Warnings []string
}

type Route

type Route struct {
	Kind    string
	Summary string
	Notes   []string
}

type Stage

type Stage struct {
	Name    string
	Status  StageStatus
	Summary string
	Changes []Change
	Notes   []string
}

type StageStatus

type StageStatus string
const (
	StageOK      StageStatus = "ok"
	StageSkipped StageStatus = "skipped"
	StageError   StageStatus = "error"
)

type Status

type Status string
const (
	StatusReady   Status = "ready"
	StatusSkipped Status = "skipped"
	StatusError   Status = "error"
)

type Var

type Var struct {
	Name     string
	Source   string
	Value    string
	Shadowed []string
	Uses     int
	Missing  bool
	Dynamic  bool
}

Jump to

Keyboard shortcuts

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