api

Documentation

Index

• func Healthz(c *gin.Context)
• type API
  • func New(s storage.Store) API
  • func (api API) Build() Build
  • func (api API) Job() Job
  • func (api API) Project() Project
• type Build
  • func (api Build) Get(c *gin.Context)
  • func (api Build) Jobs(c *gin.Context)
  • func (api Build) Logs(c *gin.Context)
• type Job
  • func (api Job) Get(c *gin.Context)
  • func (api Job) Logs(c *gin.Context)
• type Project
  • func (api Project) Builds(c *gin.Context)
  • func (api Project) Get(c *gin.Context)
  • func (api Project) List(c *gin.Context)
  • func (api Project) ListWithLatestBuild(c *gin.Context)
• type ProjectBuildSummary

Functions

func Healthz

func Healthz(c *gin.Context)

Healthz is the gin handler for the GET /healthz endpoint

Types

type API

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

API represents the rest api handlers.

func New

func New(s storage.Store) API

New creates a new api handler.

func (API) Build

func (api API) Build() Build

Build returns a handler for builds.

func (API) Job

func (api API) Job() Job

Job returns a handler for jobs.

func (API) Project

func (api API) Project() Project

Project returns a handler for projects.

type Build

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

Build represents the build api handlers.

func (Build) Get

func (api Build) Get(c *gin.Context)

Get creates a new gin handler for the GET /build/:id endpoint

func (Build) Jobs

func (api Build) Jobs(c *gin.Context)

Jobs creates a new gin handler for the GET /build/:id/jobs endpoint

func (Build) Logs

func (api Build) Logs(c *gin.Context)

Logs creates a new gin handler for the GET /job/:id/logs endpoint

type Job

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

Job represents the job api handlers.

func (Job) Get

func (api Job) Get(c *gin.Context)

Get creates a new gin handler for the GET /job/:id endpoint

func (Job) Logs

func (api Job) Logs(c *gin.Context)

Logs creates a new gin handler for the GET /job/:id/logs endpoint

type Project

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

Project represents the project api handlers.

func (Project) Builds

func (api Project) Builds(c *gin.Context)

Builds creates a new gin handler for the GET /project/:id/builds endpoint

func (Project) Get

func (api Project) Get(c *gin.Context)

Get creates a new gin handler for the GET /project/:id endpoint

func (Project) List

func (api Project) List(c *gin.Context)

List creates a new gin handler for the GET /projects endpoint

func (Project) ListWithLatestBuild

func (api Project) ListWithLatestBuild(c *gin.Context)

ListWithLatestBuild lists the projects with the latest builds attached.

type ProjectBuildSummary

type ProjectBuildSummary struct {
	Project   *brigade.Project `json:"project"`
	LastBuild *brigade.Build   `json:"lastBuild"`
}

ProjectBuildSummary is a project plus the latest build data