router

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.4.3
Schemes: http, https
BasePath: ""

Consumes:
- application/json

Produces:
- application/json

SecurityDefinitions:
  ApiKeyAuth:
    type: apiKey
    in: header
    name: Authorization

swagger:meta

Index

• func BuildHandlers(base *gin.RouterGroup)
• func ExecutorHandlers(base *gin.RouterGroup)
• func Load(options ...gin.HandlerFunc) *gin.Engine
• func PipelineHandlers(base *gin.RouterGroup)
• func RepoHandlers(base *gin.RouterGroup)

Functions

func BuildHandlers

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

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

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

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