api

Documentation

Index

• Constants
• func GetResources(api *API) http.HandlerFunc
• type API
  • func Setup(r *mux.Router, cfg *config.Config, dataStorer DataStorer) *API
• type DataStorer
• type Paginator

Constants

const (
	ParamOffset = "offset"
	ParamLimit  = "limit"
)

Functions

func GetResources

func GetResources(api *API) http.HandlerFunc

GetResources returns all resources that are wanted to be indexed in search

Types

type API

type API struct {
	Router    *mux.Router
	Cfg       *config.Config
	DataStore DataStorer
}

API provides a struct to wrap the api around

func Setup

func Setup(r *mux.Router, cfg *config.Config, dataStorer DataStorer) *API

Setup function sets up the api and returns an api

type DataStorer

type DataStorer interface {
	GetResources(ctx context.Context, options data.Options) (resource *models.Resources, err error)
}

DataStorer is an interface for a type that can store and retrieve resources

type Paginator

type Paginator interface {
	ValidateParameters(offsetParam string, limitParam string, totalCount int) (offset int, limit int, err error)
}

Paginator defines the required methods from the paginator package