types

Documentation

Index

• type ListMeta
• type ListResponse
  • func NewListResponse(total int, items interface{}) *ListResponse
• type QueryParams

Types

type ListMeta

type ListMeta struct {
	Total       int `json:"total"`
	ItemsLength int `json:"itemsLength"`
}

ListMeta describes the structure of list metadata

type ListResponse

type ListResponse struct {
	Metadata ListMeta    `json:"metadata"`
	Items    interface{} `json:"items"`
}

ListResponse describes a list

func NewListResponse

func NewListResponse(total int, items interface{}) *ListResponse

NewListResponse create a ListResponse of a list.

type QueryParams

type QueryParams struct {
	Start  int64  `source:"query,start,default=0"`
	Limit  int64  `source:"query,limit,default=99999"`
	Filter string `source:"query,filter"`
	// Sort will sorts the results by metadata.creationTimestamp
	Sort bool `source:"query,sort"`
	// Ascending will sort the results by ascending order, otherwise by descending order
	Ascending bool `source:"query,ascending"`
	// Detail determines whether to return details of list items.
	Detail bool `source:"query,detail"`
}

QueryParams describes pagination of request, start and limit defined.