Documentation
¶
Overview ¶
Package router provides the routing engine for Vela to serve and process API requests.
Usage:
import "github.com/go-vela/worker/router"
Package router Vela worker ¶
API for a Vela worker
Version: 0.0.0-dev
Schemes: http, https
Host: localhost
Consumes:
- application/json
Produces:
- application/json
SecurityDefinitions:
ApiKeyAuth:
description: Bearer token
type: apiKey
in: header
name: Authorization
swagger:meta
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildHandlers ¶ added in v0.4.0
func BuildHandlers(base *gin.RouterGroup)
BuildHandlers extends the provided base router group by adding a collection of endpoints for handling build related requests.
GET /api/v1/executors/:executor/build DELETE /api/v1/executors/:executor/build/cancel .
func ExecutorHandlers ¶ added in v0.4.0
func ExecutorHandlers(base *gin.RouterGroup)
ExecutorHandlers extends the provided base router group by adding a collection of endpoints for handling executor related requests.
GET /api/v1/executors GET /api/v1/executors/:executor GET /api/v1/executors/:executor/build DELETE /api/v1/executors/:executor/build/cancel GET /api/v1/executors/:executor/pipeline GET /api/v1/executors/:executor/repo .
func Load ¶
func Load(options ...gin.HandlerFunc) *gin.Engine
Load creates the gin.Engine with the provided options (middleware functions) for processing web and API requests for the worker.
func PipelineHandlers ¶ added in v0.4.0
func PipelineHandlers(base *gin.RouterGroup)
PipelineHandlers extends the provided base router group by adding a collection of endpoints for handling pipeline related requests.
GET /api/v1/executors/:executor/pipeline .
func RepoHandlers ¶ added in v0.4.0
func RepoHandlers(base *gin.RouterGroup)
RepoHandlers extends the provided base router group by adding a collection of endpoints for handling repo related requests.
GET /api/v1/executors/:executor/repo .
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package middleware provides the ability for injecting Vela resources into the middleware chain for the API.
|
Package middleware provides the ability for injecting Vela resources into the middleware chain for the API. |
|
perm
Package perm provides the ability for inserting Vela user permissions resources into or extracting Vela user permissions resources from the middleware chain for the API.
|
Package perm provides the ability for inserting Vela user permissions resources into or extracting Vela user permissions resources from the middleware chain for the API. |
|
token
Package token provides the ability for inserting Vela token resources into or extracting Vela token resources from the middleware chain for the API.
|
Package token provides the ability for inserting Vela token resources into or extracting Vela token resources from the middleware chain for the API. |
|
user
Package user provides the ability for inserting Vela user resources into or extracting Vela user resources from the middleware chain for the API.
|
Package user provides the ability for inserting Vela user resources into or extracting Vela user resources from the middleware chain for the API. |