paging

Documentation

Index

• func PageDefinitionParameter() definition.Parameter
• func ValidateListOption(opts *ListOption) error
• type ListMeta
• type ListOption
• type Result
  • func Page(items interface{}, opts *ListOption) Result

Functions

func PageDefinitionParameter

func PageDefinitionParameter() definition.Parameter

PageDefinitionParameter is used for apis/descriptors to define Definition's Parameter.

func ValidateListOption

func ValidateListOption(opts *ListOption) error

ValidateListOption is validating the ListOption.

Types

type ListMeta

type ListMeta struct {
	// Total number of items on the list. Used for pagination.
	TotalItems int `json:"totalItems"`
}

ListMeta describes list of objects, i.e. holds information about pagination options set for the list.

type ListOption

type ListOption struct {
	Start int  `source:"Query,start"`
	Limit *int `source:"Query,limit"`
}

ListOption is params in query which is used for paging.

type Result

type Result struct {
	ListMeta `json:"metadata"`
	Items    []interface{} `json:"items"`
}

func Page

func Page(items interface{}, opts *ListOption) Result

Page is page the input items datas.