api

package

Go to main page

Versions in this module

v0

v0.6.0

Jun 3, 2026

Changes in this version

+ var JobModifiedConcurrently = api.Error

v0.5.0

Mar 10, 2026

Changes in this version

+ const EligibleKey

v0.4.1

Aug 28, 2025

v0.4.0

Jul 15, 2025

Changes in this version

+ type JQFilter struct

+ func NewJQFilter(filter string, body any) JQFilter

+ func (jq JQFilter) VisitDeleteJobsIdResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitDeleteJobsIdTagsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitDeleteWorkflowsNameResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetHealthResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetJobsEventsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetJobsIdDefinitionResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetJobsIdResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetJobsIdStatusResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetJobsIdTagsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetJobsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetVersionResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetWorkflowsNameResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitGetWorkflowsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitPostJobsIdTagsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitPostJobsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitPostWorkflowsResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitPutJobsIdDefinitionResponse(w http.ResponseWriter) error

+ func (jq JQFilter) VisitPutJobsIdStatusResponse(w http.ResponseWriter) error

+ type NorthboundServer struct

+ func NewNorthboundServer(wfx *WfxServer) NorthboundServer

+ func (north NorthboundServer) DeleteJobsId(ctx context.Context, request api.DeleteJobsIdRequestObject) (api.DeleteJobsIdResponseObject, error)

+ func (north NorthboundServer) DeleteJobsIdTags(ctx context.Context, request api.DeleteJobsIdTagsRequestObject) (api.DeleteJobsIdTagsResponseObject, error)

+ func (north NorthboundServer) DeleteWorkflowsName(ctx context.Context, request api.DeleteWorkflowsNameRequestObject) (api.DeleteWorkflowsNameResponseObject, error)

+ func (north NorthboundServer) GetHealth(ctx context.Context, request api.GetHealthRequestObject) (api.GetHealthResponseObject, error)

+ func (north NorthboundServer) GetJobs(ctx context.Context, request api.GetJobsRequestObject) (api.GetJobsResponseObject, error)

+ func (north NorthboundServer) GetJobsEvents(ctx context.Context, request api.GetJobsEventsRequestObject) (api.GetJobsEventsResponseObject, error)

+ func (north NorthboundServer) GetJobsId(ctx context.Context, request api.GetJobsIdRequestObject) (api.GetJobsIdResponseObject, error)

+ func (north NorthboundServer) GetJobsIdDefinition(ctx context.Context, request api.GetJobsIdDefinitionRequestObject) (api.GetJobsIdDefinitionResponseObject, error)

+ func (north NorthboundServer) GetJobsIdStatus(ctx context.Context, request api.GetJobsIdStatusRequestObject) (api.GetJobsIdStatusResponseObject, error)

+ func (north NorthboundServer) GetJobsIdTags(ctx context.Context, request api.GetJobsIdTagsRequestObject) (api.GetJobsIdTagsResponseObject, error)

+ func (north NorthboundServer) GetVersion(ctx context.Context, request api.GetVersionRequestObject) (api.GetVersionResponseObject, error)

+ func (north NorthboundServer) GetWorkflows(ctx context.Context, request api.GetWorkflowsRequestObject) (api.GetWorkflowsResponseObject, error)

+ func (north NorthboundServer) GetWorkflowsName(ctx context.Context, request api.GetWorkflowsNameRequestObject) (api.GetWorkflowsNameResponseObject, error)

+ func (north NorthboundServer) PostJobs(ctx context.Context, request api.PostJobsRequestObject) (api.PostJobsResponseObject, error)

+ func (north NorthboundServer) PostJobsIdTags(ctx context.Context, request api.PostJobsIdTagsRequestObject) (api.PostJobsIdTagsResponseObject, error)

+ func (north NorthboundServer) PostWorkflows(ctx context.Context, request api.PostWorkflowsRequestObject) (api.PostWorkflowsResponseObject, error)

+ func (north NorthboundServer) PutJobsIdDefinition(ctx context.Context, request api.PutJobsIdDefinitionRequestObject) (api.PutJobsIdDefinitionResponseObject, error)

+ func (north NorthboundServer) PutJobsIdStatus(ctx context.Context, request api.PutJobsIdStatusRequestObject) (api.PutJobsIdStatusResponseObject, error)

+ type SSEOpts struct

+ GraceInterval time.Duration

+ PingInterval time.Duration

+ type SouthboundServer struct

+ func NewSouthboundServer(wfx *WfxServer) SouthboundServer

+ func (south SouthboundServer) DeleteJobsId(context.Context, api.DeleteJobsIdRequestObject) (api.DeleteJobsIdResponseObject, error)

+ func (south SouthboundServer) DeleteJobsIdTags(context.Context, api.DeleteJobsIdTagsRequestObject) (api.DeleteJobsIdTagsResponseObject, error)

+ func (south SouthboundServer) DeleteWorkflowsName(context.Context, api.DeleteWorkflowsNameRequestObject) (api.DeleteWorkflowsNameResponseObject, error)

+ func (south SouthboundServer) GetHealth(ctx context.Context, request api.GetHealthRequestObject) (api.GetHealthResponseObject, error)

+ func (south SouthboundServer) GetJobs(ctx context.Context, request api.GetJobsRequestObject) (api.GetJobsResponseObject, error)

+ func (south SouthboundServer) GetJobsEvents(ctx context.Context, request api.GetJobsEventsRequestObject) (api.GetJobsEventsResponseObject, error)

+ func (south SouthboundServer) GetJobsId(ctx context.Context, request api.GetJobsIdRequestObject) (api.GetJobsIdResponseObject, error)

+ func (south SouthboundServer) GetJobsIdDefinition(ctx context.Context, request api.GetJobsIdDefinitionRequestObject) (api.GetJobsIdDefinitionResponseObject, error)

+ func (south SouthboundServer) GetJobsIdStatus(ctx context.Context, request api.GetJobsIdStatusRequestObject) (api.GetJobsIdStatusResponseObject, error)

+ func (south SouthboundServer) GetJobsIdTags(ctx context.Context, request api.GetJobsIdTagsRequestObject) (api.GetJobsIdTagsResponseObject, error)

+ func (south SouthboundServer) GetVersion(ctx context.Context, request api.GetVersionRequestObject) (api.GetVersionResponseObject, error)

+ func (south SouthboundServer) GetWorkflows(ctx context.Context, request api.GetWorkflowsRequestObject) (api.GetWorkflowsResponseObject, error)

+ func (south SouthboundServer) GetWorkflowsName(ctx context.Context, request api.GetWorkflowsNameRequestObject) (api.GetWorkflowsNameResponseObject, error)

+ func (south SouthboundServer) PostJobs(context.Context, api.PostJobsRequestObject) (api.PostJobsResponseObject, error)

+ func (south SouthboundServer) PostJobsIdTags(context.Context, api.PostJobsIdTagsRequestObject) (api.PostJobsIdTagsResponseObject, error)

+ func (south SouthboundServer) PostWorkflows(context.Context, api.PostWorkflowsRequestObject) (api.PostWorkflowsResponseObject, error)

+ func (south SouthboundServer) PutJobsIdDefinition(ctx context.Context, request api.PutJobsIdDefinitionRequestObject) (api.PutJobsIdDefinitionResponseObject, error)

+ func (south SouthboundServer) PutJobsIdStatus(ctx context.Context, request api.PutJobsIdStatusRequestObject) (api.PutJobsIdStatusResponseObject, error)

+ type WfxServer struct

+ func NewWfxServer(storage persistence.Storage) *WfxServer

+ func (server *WfxServer) WithSSEOpts(sseOpts SSEOpts) *WfxServer

+ func (server WfxServer) DeleteJobsId(ctx context.Context, request api.DeleteJobsIdRequestObject) (api.DeleteJobsIdResponseObject, error)

+ func (server WfxServer) DeleteJobsIdTags(ctx context.Context, request api.DeleteJobsIdTagsRequestObject) (api.DeleteJobsIdTagsResponseObject, error)

+ func (server WfxServer) DeleteWorkflowsName(ctx context.Context, request api.DeleteWorkflowsNameRequestObject) (api.DeleteWorkflowsNameResponseObject, error)

+ func (server WfxServer) GetHealth(ctx context.Context, _ api.GetHealthRequestObject) (api.GetHealthResponseObject, error)

+ func (server WfxServer) GetJobs(ctx context.Context, request api.GetJobsRequestObject) (api.GetJobsResponseObject, error)

+ func (server WfxServer) GetJobsEvents(ctx context.Context, request api.GetJobsEventsRequestObject) (api.GetJobsEventsResponseObject, error)

+ func (server WfxServer) GetJobsId(ctx context.Context, request api.GetJobsIdRequestObject) (api.GetJobsIdResponseObject, error)

+ func (server WfxServer) GetJobsIdDefinition(ctx context.Context, request api.GetJobsIdDefinitionRequestObject) (api.GetJobsIdDefinitionResponseObject, error)

+ func (server WfxServer) GetJobsIdStatus(ctx context.Context, request api.GetJobsIdStatusRequestObject) (api.GetJobsIdStatusResponseObject, error)

+ func (server WfxServer) GetJobsIdTags(ctx context.Context, request api.GetJobsIdTagsRequestObject) (api.GetJobsIdTagsResponseObject, error)

+ func (server WfxServer) GetVersion(context.Context, api.GetVersionRequestObject) (api.GetVersionResponseObject, error)

+ func (server WfxServer) GetWorkflows(ctx context.Context, request api.GetWorkflowsRequestObject) (api.GetWorkflowsResponseObject, error)

+ func (server WfxServer) GetWorkflowsName(ctx context.Context, request api.GetWorkflowsNameRequestObject) (api.GetWorkflowsNameResponseObject, error)

+ func (server WfxServer) PostJobs(ctx context.Context, request api.PostJobsRequestObject) (api.PostJobsResponseObject, error)

+ func (server WfxServer) PostJobsIdTags(ctx context.Context, request api.PostJobsIdTagsRequestObject) (api.PostJobsIdTagsResponseObject, error)

+ func (server WfxServer) PostWorkflows(ctx context.Context, request api.PostWorkflowsRequestObject) (api.PostWorkflowsResponseObject, error)

+ func (server WfxServer) PutJobsIdDefinition(ctx context.Context, request api.PutJobsIdDefinitionRequestObject) (api.PutJobsIdDefinitionResponseObject, error)

+ func (server WfxServer) PutJobsIdStatus(ctx context.Context, request api.PutJobsIdStatusRequestObject, ...) (api.PutJobsIdStatusResponseObject, error)

+ func (server WfxServer) Start()

+ func (server WfxServer) Stop()

v0.3.3

Dec 23, 2024

v0.3.2

Sep 3, 2024

v0.3.1

Jul 9, 2024

v0.3.0

May 2, 2024

v0.2.0

Jan 15, 2024

v0.1.0

Jun 2, 2023

Changes in this version

+ var InvalidRequest = model.Error

+ var JobNotFound = model.Error

+ var WorkflowInvalid = model.Error

+ var WorkflowNotFound = model.Error

+ var WorkflowNotUnique = model.Error

+ func NewNorthboundAPI(storage persistence.Storage) (*operations.WorkflowExecutorAPI, error)

+ func NewSouthboundAPI(storage persistence.Storage) (*operations.WorkflowExecutorAPI, error)

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