list

type List struct {
	// Any use this for cases where you need to pass something down to the
	// adapter.
	Any interface{} `json:"any" query:"any" param:"any" form:"any" validate:"omitempty,gt=0"`

	// Count is used for response, and it is the total number of items.
	Count int64 `json:"count" validate:"omitempty,gte=0" default:"0"`

	// Fields to be included in the response.
	Fields field.Fields `json:"fields" query:"fields" param:"fields" form:"fields" validate:"omitempty,gt=0"`

	// Limit is the maximum number of items to return.
	//
	// NOTE: Default value is 10. It's bad practice to return all items.
	Limit int `json:"limit" query:"limit" param:"limit" form:"limit" validate:"omitempty,gt=0" default:"10"`

	// Offset is the number of items to skip before starting to collect the
	// result set.
	Offset int `json:"offset" query:"offset" param:"offset" form:"offset" validate:"omitempty,gte=0" default:"0"`

	// Search is the search query.
	Search string `json:"search" query:"search" param:"search" form:"search" validate:"omitempty,gt=0"`

	// SearchRaw if set is passed right way to the adapter.
	//
	// NOTE: NOT all adapters support this feature.
	SearchRaw string `json:"search_raw" query:"search_raw" param:"search_raw" form:"search_raw" validate:"omitempty,gt=0"`

	// Sort is the sort query.
	Sort customsort.SortMap `json:"sort" query:"sort" param:"sort" form:"sort" validate:"omitempty,gt=0"`
}