servant-auth-token-api-0.1.2.0: Servant based API for token based authorisation

Copyright(c) Anton Gushcha, 2016
LicenseMIT
Maintainerncrashed@gmail.com
Stabilityexperimental
PortabilityPortable
Safe HaskellNone
LanguageHaskell2010

Servant.API.Auth.Token.Pagination

Contents

Description

 

Synopsis

API types

type PageParam = QueryParam "page" Page Source

Query parameter that carries pagination page number

type Page = Word Source

A page number

type PageSizeParam = QueryParam "size" PageSize Source

Query parameter that carries pagination page size value

type PageSize = Word Source

Number of items on a page

Helpers

data PagedList i a Source

Collection of a with attached ids of type i and additional page info.

Constructors

PagedList 

Fields

pagedListItems :: ![WithId i a]

Payload

pagedListPages :: !Word

Count of available pages

Instances