api

Documentation

Index

• Constants
• type Controller
  • func NewController(index *index.Index, listen string, CORSAllowAll bool) *Controller
  • func (c *Controller) Serve(ctx context.Context, wg *sync.WaitGroup)
• type ListRepositoriesResponse
• type RepositoryStatus
• type SearchQuery
• type SearchResponse

Constants

const (
	// DefaultLimit is the default pagination limit
	DefaultLimit = 10
)

Types

type Controller

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

The Controller implements the API endpoints

func NewController

func NewController(index *index.Index, listen string, CORSAllowAll bool) *Controller

NewController creates a new Controller instance fully ready to serve

func (*Controller) Serve

func (c *Controller) Serve(ctx context.Context, wg *sync.WaitGroup)

Serve starts the controller as a background process until the context is cancelled

type ListRepositoriesResponse

type ListRepositoriesResponse struct {
	Repositories []RepositoryStatus `json:"repositories"`
}

ListRepositoriesResponse contains the response from listing all repositories

type RepositoryStatus

type RepositoryStatus struct {
	Name   string `json:"name"`
	Images int    `json:"images"`
}

RepositoryStatus contains the status of a single repository

type SearchQuery

type SearchQuery struct {
	Labels        map[string]string `json:"labels"`
	CreatedAfter  time.Time         `json:"created_after"`
	CreatedBefore time.Time         `json:"created_before"`
}

SearchQuery contains the parameters for an image search

type SearchResponse

type SearchResponse struct {
	Repository string         `json:"name"`
	Images     []*index.Image `json:"images"`
	Offset     int            `json:"offset"`
	Limit      int            `json:"limit"`
	Count      int            `json:"count"`
}

SearchResponse contrainer the result of an image search