agentstudioapi

package
v1.42.0 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const Description = `AgentStudio is a developer console for inspecting flows running under the Foreman.`

Description is the human-readable summary of the microservice, surfaced in OpenAPI and discovery.

View Source 
const Hostname = "agentstudio.dev"

Hostname is the default hostname of the microservice.

View Source 
const Name = "AgentStudio"

Name is the decorative PascalCase name of the microservice.

View Source 
const Version = 7

Version is a generation counter bumped on each regeneration, not a semantic version.

Variables

View Source 
var Assets = define.Web{
	Host: Hostname, Method: "GET", Route: "//bespa/{path...}",
}

Assets serves the bespa CSS and JavaScript assets at /bespa/.

View Source 
var ContinueFlow = define.Web{
	Host: Hostname, Method: "ANY", Route: "/continue-flow",
}

ContinueFlow renders a form to continue a completed flow's thread with additional state.

View Source 
var Dashboard = define.Web{
	Host: Hostname, Method: "ANY", Route: "/dashboard",
}

Dashboard renders an HTML page with operator dashboards for flows and workflows.

View Source 
var FlowDetail = define.Web{
	Host: Hostname, Method: "ANY", Route: "/flows/{flowKey}",
}

FlowDetail renders an HTML page with the details, DAG diagram, and step log of a flow.

View Source 
var ListFlows = define.Web{
	Host: Hostname, Method: "ANY", Route: "/flows",
}

ListFlows renders an HTML page with a paginated, sortable table of flows.

View Source 
var ListWorkflows = define.Web{
	Host: Hostname, Method: "ANY", Route: "/workflows",
}

ListWorkflows renders an HTML page listing the workflows available in the system.

View Source 
var PollFlow = define.Web{
	Host: Hostname, Method: "GET", Route: "/poll-flow",
}

PollFlow returns a JSON status payload driving the FlowDetail live-update progress bar.

View Source 
var RestartFlow = define.Web{
	Host: Hostname, Method: "ANY", Route: "/restart-flow",
}

RestartFlow renders a form to restart a terminated flow from its entry step with optional state overrides.

View Source 
var RestartFromStep = define.Web{
	Host: Hostname, Method: "ANY", Route: "/restart-from-step",
}

RestartFromStep renders a form to restart a flow from a specific step with optional state overrides.

View Source 
var ResumeFlow = define.Web{
	Host: Hostname, Method: "ANY", Route: "/resume-flow",
}

ResumeFlow renders a form to resume an interrupted flow with a resume payload.

View Source 
var RunWorkflow = define.Web{
	Host: Hostname, Method: "ANY", Route: "/run-workflow",
}

RunWorkflow renders a form to create and start a workflow with an initial state and FlowOptions.

View Source 
var StepDetail = define.Web{
	Host: Hostname, Method: "ANY", Route: "/steps/{stepKey}",
}

StepDetail renders an HTML page with the details of one execution step.

View Source 
var TaskDetail = define.Web{
	Host: Hostname, Method: "ANY", Route: "/task-detail",
}

TaskDetail renders an HTML page with the metadata of a single task in a workflow graph.

View Source 
var WorkflowDetail = define.Web{
	Host: Hostname, Method: "ANY", Route: "/workflows/{workflowURL...}",
}

WorkflowDetail renders an HTML page with the structure and definition of a single workflow graph.

Functions

This section is empty.

Types

type Client 

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

Client is a lightweight proxy for making unicast calls to the microservice.

func NewClient 

func NewClient(caller service.Publisher) Client

NewClient creates a new unicast client proxy to the microservice.

func (Client) Assets 

func (_c Client) Assets(ctx context.Context, relativeURL string) (res *http.Response, err error)

Assets serves the bespa CSS and JavaScript assets at /bespa/.

func (Client) ContinueFlow added in v1.41.0 

func (_c Client) ContinueFlow(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

ContinueFlow renders a form to continue a completed flow's thread with additional state.

func (Client) Dashboard 

func (_c Client) Dashboard(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

Dashboard renders an HTML page with operator dashboards for flows and workflows.

func (Client) FlowDetail 

func (_c Client) FlowDetail(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

FlowDetail renders an HTML page with the details, DAG diagram, and step log of a flow.

func (Client) ForHost 

func (_c Client) ForHost(host string) Client

ForHost returns a copy of the client with a different hostname to be applied to requests.

func (Client) ListFlows 

func (_c Client) ListFlows(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

ListFlows renders an HTML page with a paginated, sortable table of flows.

func (Client) ListWorkflows 

func (_c Client) ListWorkflows(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

ListWorkflows renders an HTML page listing the workflows available in the system.

func (Client) PollFlow added in v1.41.0 

func (_c Client) PollFlow(ctx context.Context, relativeURL string) (res *http.Response, err error)

PollFlow returns a JSON status payload driving the FlowDetail live-update progress bar.

func (Client) RestartFlow added in v1.41.0 

func (_c Client) RestartFlow(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

RestartFlow renders a form to restart a terminated flow from its entry step with optional state overrides.

func (Client) RestartFromStep added in v1.41.0 

func (_c Client) RestartFromStep(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

RestartFromStep renders a form to restart a flow from a specific step with optional state overrides.

func (Client) ResumeFlow added in v1.41.0 

func (_c Client) ResumeFlow(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

ResumeFlow renders a form to resume an interrupted flow with a resume payload.

func (Client) RunWorkflow added in v1.41.0 

func (_c Client) RunWorkflow(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

RunWorkflow renders a form to create and start a workflow with an initial state and FlowOptions.

func (Client) StepDetail added in v1.41.0 

func (_c Client) StepDetail(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

StepDetail renders an HTML page with the details of one execution step.

func (Client) TaskDetail 

func (_c Client) TaskDetail(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

TaskDetail renders an HTML page with the metadata of a single task in a workflow graph.

func (Client) WithOptions 

func (_c Client) WithOptions(opts ...pub.Option) Client

WithOptions returns a copy of the client with options to be applied to requests.

func (Client) WorkflowDetail 

func (_c Client) WorkflowDetail(ctx context.Context, method string, relativeURL string, body any) (res *http.Response, err error)

WorkflowDetail renders an HTML page with the structure and definition of a single workflow graph.

type MulticastClient 

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

MulticastClient is a lightweight proxy for making multicast calls to the microservice.

func NewMulticastClient 

func NewMulticastClient(caller service.Publisher) MulticastClient

NewMulticastClient creates a new multicast client proxy to the microservice.

func (MulticastClient) Assets 

func (_c MulticastClient) Assets(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

Assets serves the bespa CSS and JavaScript assets at /bespa/.

func (MulticastClient) ContinueFlow added in v1.41.0 

func (_c MulticastClient) ContinueFlow(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

ContinueFlow renders a form to continue a completed flow's thread with additional state.

func (MulticastClient) Dashboard 

func (_c MulticastClient) Dashboard(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

Dashboard renders an HTML page with operator dashboards for flows and workflows.

func (MulticastClient) FlowDetail 

func (_c MulticastClient) FlowDetail(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

FlowDetail renders an HTML page with the details, DAG diagram, and step log of a flow.

func (MulticastClient) ForHost 

func (_c MulticastClient) ForHost(host string) MulticastClient

ForHost returns a copy of the client with a different hostname to be applied to requests.

func (MulticastClient) ListFlows 

func (_c MulticastClient) ListFlows(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

ListFlows renders an HTML page with a paginated, sortable table of flows.

func (MulticastClient) ListWorkflows 

func (_c MulticastClient) ListWorkflows(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

ListWorkflows renders an HTML page listing the workflows available in the system.

func (MulticastClient) PollFlow added in v1.41.0 

func (_c MulticastClient) PollFlow(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

PollFlow returns a JSON status payload driving the FlowDetail live-update progress bar.

func (MulticastClient) RestartFlow added in v1.41.0 

func (_c MulticastClient) RestartFlow(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

RestartFlow renders a form to restart a terminated flow from its entry step with optional state overrides.

func (MulticastClient) RestartFromStep added in v1.41.0 

func (_c MulticastClient) RestartFromStep(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

RestartFromStep renders a form to restart a flow from a specific step with optional state overrides.

func (MulticastClient) ResumeFlow added in v1.41.0 

func (_c MulticastClient) ResumeFlow(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

ResumeFlow renders a form to resume an interrupted flow with a resume payload.

func (MulticastClient) RunWorkflow added in v1.41.0 

func (_c MulticastClient) RunWorkflow(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

RunWorkflow renders a form to create and start a workflow with an initial state and FlowOptions.

func (MulticastClient) StepDetail added in v1.41.0 

func (_c MulticastClient) StepDetail(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

StepDetail renders an HTML page with the details of one execution step.

func (MulticastClient) TaskDetail 

func (_c MulticastClient) TaskDetail(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

TaskDetail renders an HTML page with the metadata of a single task in a workflow graph.

func (MulticastClient) WithOptions 

func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient

WithOptions returns a copy of the client with options to be applied to requests.

func (MulticastClient) WorkflowDetail 

func (_c MulticastClient) WorkflowDetail(ctx context.Context, method string, relativeURL string, body any) iter.Seq[*pub.Response]

WorkflowDetail renders an HTML page with the structure and definition of a single workflow graph.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.