common

Documentation

Index

• Constants
• func GetFilter(request *restful.Request, filterOpts []string) (map[string]string, error)
• func GetPaginationParam(request *restful.Request) (int32, int32, error)
• func GetSortParam(request *restful.Request) (sortKeys []string, sortDirs []string, err error)

Constants

const (
	MaxPaginationLimit      = 1000
	DefaultPaginationLimit  = MaxPaginationLimit
	DefaultPaginationOffset = 0
	SortDirectionAsc        = "asc"
	SortDirectionDesc       = "desc"
)

const (
	KLimit  = "limit"
	KOffset = "offset"
	KSort   = "sort"
)

Functions

func GetFilter

func GetFilter(request *restful.Request, filterOpts []string) (map[string]string, error)

func GetPaginationParam

func GetPaginationParam(request *restful.Request) (int32, int32, error)

func GetSortParam

func GetSortParam(request *restful.Request) (sortKeys []string, sortDirs []string, err error)

An example of sort key parameter will be like this: sort=key1:asc,key2:desc