Servant.API.Auth.Token.Pagination

API types

type PageParam = QueryParam "page" Page

Query parameter that carries pagination page number

type Page = Word

A page number

type PageSizeParam = QueryParam "size" PageSize

Query parameter that carries pagination page size value

type PageSize = Word

Number of items on a page

Helpers

data PagedList i a

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

(Show i, Show a) => Show (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

Methods

showsPrec :: Int -> PagedList i a -> ShowS

show :: PagedList i a -> String

showList :: [PagedList i a] -> ShowS

Generic (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

Associated Types

type Rep (PagedList i a) :: Type -> Type

Methods

from :: PagedList i a -> Rep (PagedList i a) x

to :: Rep (PagedList i a) x -> PagedList i a

(ToJSON i, ToJSON a) => ToJSON (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

Methods

toJSON :: PagedList i a -> Value

toEncoding :: PagedList i a -> Encoding

toJSONList :: [PagedList i a] -> Value

toEncodingList :: [PagedList i a] -> Encoding

(FromJSON i, FromJSON a) => FromJSON (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

Methods

parseJSON :: Value -> Parser (PagedList i a)

parseJSONList :: Value -> Parser [PagedList i a]

(Typeable i, Typeable a, ToSchema i, ToSchema a) => ToSchema (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

Methods

declareNamedSchema :: Proxy (PagedList i a) -> Declare (Definitions Schema) NamedSchema

(ToSample i, ToSample a) => ToSample (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

Methods

toSamples :: Proxy (PagedList i a) -> [(Text, PagedList i a)]

type Rep (PagedList i a)

Defined in Servant.API.Auth.Token.Pagination

type Rep (PagedList i a) = D1 (MetaData "PagedList" "Servant.API.Auth.Token.Pagination" "servant-auth-token-api-0.5.4.0-inplace" False) (C1 (MetaCons "PagedList" PrefixI True) (S1 (MetaSel (Just "pagedListItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [WithId i a]) :*: S1 (MetaSel (Just "pagedListPages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word)))

Orphan instances

ToParam PageSizeParam

Methods

toParam :: Proxy PageSizeParam -> DocQueryParam

ToParam PageParam

Methods

toParam :: Proxy PageParam -> DocQueryParam