web

package
v0.0.0-...-537fcec Latest Latest
Warning

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

Go to latest
Published: Mar 12, 2018 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package web handles receiving and supplying information within the node.

Router

Router defines the valid paths for the node and responds to requests.

JobsController

JobsController allows for the creation of Jobs to be added to the node, and shows the current jobs which have already been added.

JobRunsController

JobRunsController allows for the creation of JobRuns within a given Job on the node.

BridgeTypesController

BridgeTypesController allows for the creation of BridgeTypes on the node. BridgeTypes are the external adapters which add functionality not available in the core, from outside the node.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Router

Router listens and responds to requests to the node for valid paths.

Types

type BridgeTypesController

type BridgeTypesController struct {
	App *services.ChainlinkApplication
}

BridgeTypesController manages BridgeType requests in the node.

func (*BridgeTypesController) Create

func (btc *BridgeTypesController) Create(c *gin.Context)

Create adds the BridgeType to the given context.

type JobRunsController

type JobRunsController struct {
	App *services.ChainlinkApplication
}

JobRunsController manages JobRun requests in the node.

func (*JobRunsController) Create

func (jrc *JobRunsController) Create(c *gin.Context)

Create starts a new Run for the requested JobSpec. Example:

"<application>/specs/:SpecID/runs"

func (*JobRunsController) Index

func (jrc *JobRunsController) Index(c *gin.Context)

Index lists all of the Runs of a JobSpec. Example:

"<application>/specs/:SpecID/runs"

func (*JobRunsController) Update

func (jrc *JobRunsController) Update(c *gin.Context)

Update allows external adapters to resume a JobRun, reporting the result of the task and marking it no longer pending. Example:

"<application>/runs/:RunID"

type JobSpecsController

type JobSpecsController struct {
	App *services.ChainlinkApplication
}

JobSpecsController manages JobSpec requests.

func (*JobSpecsController) Create

func (jsc *JobSpecsController) Create(c *gin.Context)

Create adds validates, saves, and starts a new JobSpec. Example:

"<application>/specs"

func (*JobSpecsController) Index

func (jsc *JobSpecsController) Index(c *gin.Context)

Index lists all of the existing JobSpecs. Example:

"<application>/specs"

func (*JobSpecsController) Show

func (jsc *JobSpecsController) Show(c *gin.Context)

Show returns the details of a JobSpec. Example:

"<application>/specs/:SpecID"

Jump to

Keyboard shortcuts

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