http

Documentation

Index

• Constants
• Variables
• func NewRouter(dataStore store.DataStore, nats nats.Client) *gin.Engine
• type StatusController
  • func NewStatusController() *StatusController
  • func (h StatusController) Status(c *gin.Context)
• type WorkflowController
  • func NewWorkflowController(dataStore store.DataStore, nats nats.Client) *WorkflowController
  • func (h WorkflowController) GetJobByID(c *gin.Context)
  • func (h WorkflowController) GetWorkflowByNameAndID(c *gin.Context)
  • func (h WorkflowController) GetWorkflows(c *gin.Context)
  • func (h WorkflowController) HealthCheck(c *gin.Context)
  • func (h WorkflowController) RegisterWorkflow(c *gin.Context)
  • func (h WorkflowController) StartBatchWorkflows(c *gin.Context)
  • func (h WorkflowController) StartWorkflow(c *gin.Context)

Constants

const (
	APIURLStatus = "/status"

	APIURLHealth        = "/api/v1/health"
	APIURLWorkflow      = "/api/v1/workflow/:name"
	APIURLWorkflowBatch = "/api/v1/workflow/:name/batch"
	APIURLWorkflowID    = "/api/v1/workflow/:name/:id"
	APIURLJobsID        = "/api/v1/jobs/:id"

	APIURLWorkflows = "/api/v1/metadata/workflows"
)

API URL used by the HTTP router

Variables

var (
	HeaderWorkflowMinVersion = "X-Workflows-Min-Version"
)

Functions

func NewRouter

func NewRouter(dataStore store.DataStore, nats nats.Client) *gin.Engine

NewRouter returns the gin router

Types

type StatusController

type StatusController struct{}

StatusController contains status-related end-points

func NewStatusController

func NewStatusController() *StatusController

NewStatusController returns a new StatusController

func (StatusController) Status

func (h StatusController) Status(c *gin.Context)

Status responds to GET /status

type WorkflowController

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

WorkflowController container for end-points

func NewWorkflowController

func NewWorkflowController(dataStore store.DataStore, nats nats.Client) *WorkflowController

NewWorkflowController returns a new StatusController

func (WorkflowController) GetJobByID

func (h WorkflowController) GetJobByID(c *gin.Context)

GetJobByID responds to GET /api/jobs/:id

func (WorkflowController) GetWorkflowByNameAndID

func (h WorkflowController) GetWorkflowByNameAndID(c *gin.Context)

GetWorkflowByNameAndID responds to GET /api/workflow/:name/:id

func (WorkflowController) GetWorkflows

func (h WorkflowController) GetWorkflows(c *gin.Context)

GetWorkflows responds to GET /api/v1/metadata/workflows

func (WorkflowController) HealthCheck

func (h WorkflowController) HealthCheck(c *gin.Context)

func (WorkflowController) RegisterWorkflow

func (h WorkflowController) RegisterWorkflow(c *gin.Context)

RegisterWorkflow responds to POST /api/v1/metadata/workflows

func (WorkflowController) StartBatchWorkflows

func (h WorkflowController) StartBatchWorkflows(c *gin.Context)

StartBatchWorkflows responds to POST /api/workflow/:name/batch

func (WorkflowController) StartWorkflow

func (h WorkflowController) StartWorkflow(c *gin.Context)

StartWorkflow responds to POST /api/workflow/:name