route

Documentation

Index

• Constants
• func AttachHandler(app *gimlet.APIApp, opts HandlerOpts)
• func GetProjectContext(ctx context.Context) *model.Context
• func MustHaveProjectContext(ctx context.Context) *model.Context
• func MustHaveUser(ctx context.Context) *user.DBUser
• func NewCommitQueueItemOwnerMiddleware(sc data.Connector) gimlet.Middleware
• func NewProjectAdminMiddleware(sc data.Connector) gimlet.Middleware
• func NewProjectContextMiddleware(sc data.Connector) gimlet.Middleware
• func NewTaskAuthMiddleware(sc data.Connector) gimlet.Middleware
• type CommitQueueItemOwnerMiddleware
  • func (m *CommitQueueItemOwnerMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type HandlerOpts
• type StatsHandler
  • func (sh *StatsHandler) ParseCommonFilter(vals url.Values) error
• type TaskAuthMiddleware
  • func (m *TaskAuthMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

Constants

const (

	// GroupBy API values for tasks
	StatsAPITaskGroupByDistro  = "task_variant_distro"
	StatsAPITaskGroupByVariant = "task_variant"
	StatsAPITaskGroupByTask    = "task"
)

const (
	// Key value used to map user and project data to request context.
	// These are private custom types to avoid key collisions.
	RequestContext requestContextKey = 0
)

Functions

func AttachHandler

func AttachHandler(app *gimlet.APIApp, opts HandlerOpts)

AttachHandler attaches the api's request handlers to the given mux router. It builds a Connector then attaches each of the main functions for the api to the router.

func GetProjectContext

func GetProjectContext(ctx context.Context) *model.Context

GetProjectContext returns the project context associated with a given request.

func MustHaveProjectContext

func MustHaveProjectContext(ctx context.Context) *model.Context

MustHaveProjectContext returns the project context set on the http request context. It panics if none is set.

func MustHaveUser

func MustHaveUser(ctx context.Context) *user.DBUser

MustHaveUser returns the user associated with a given request or panics if none is present.

func NewCommitQueueItemOwnerMiddleware

func NewCommitQueueItemOwnerMiddleware(sc data.Connector) gimlet.Middleware

func NewProjectAdminMiddleware

func NewProjectAdminMiddleware(sc data.Connector) gimlet.Middleware

func NewProjectContextMiddleware

func NewProjectContextMiddleware(sc data.Connector) gimlet.Middleware

func NewTaskAuthMiddleware

func NewTaskAuthMiddleware(sc data.Connector) gimlet.Middleware

Types

type CommitQueueItemOwnerMiddleware

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

func (*CommitQueueItemOwnerMiddleware) ServeHTTP

func (m *CommitQueueItemOwnerMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type HandlerOpts

type HandlerOpts struct {
	APIQueue     amboy.Queue
	QueueGroup   amboy.QueueGroup
	URL          string
	SuperUsers   []string
	GithubSecret []byte
}

type StatsHandler

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

func (*StatsHandler) ParseCommonFilter

func (sh *StatsHandler) ParseCommonFilter(vals url.Values) error

ParseCommonFilter parses the query parameter values and fills the struct filter field.

type TaskAuthMiddleware

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

func (*TaskAuthMiddleware) ServeHTTP

func (m *TaskAuthMiddleware) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)