Network.JSONApi.Meta

Module representing a JSON-API meta object.

Specification: http://jsonapi.org/format/#document-meta

Documentation

data Meta

Type representing a JSON-API meta object.

Meta is an abstraction around an underlying Map consisting of resource-specific metadata.

Example JSON: "meta": { "copyright": "Copyright 2015 Example Corp.", "authors": [ "Andre Dawson", "Kirby Puckett", "Don Mattingly", "Ozzie Guillen" ] }

Specification: http://jsonapi.org/format/#document-meta

Instances

Eq Meta

Defined in Network.JSONApi.Meta

Methods

(==) :: Meta -> Meta -> Bool

(/=) :: Meta -> Meta -> Bool

Show Meta

Defined in Network.JSONApi.Meta

Methods

showsPrec :: Int -> Meta -> ShowS

show :: Meta -> String

showList :: [Meta] -> ShowS

Generic Meta

Defined in Network.JSONApi.Meta

Associated Types

type Rep Meta :: Type -> Type

Methods

from :: Meta -> Rep Meta x

to :: Rep Meta x -> Meta

ToJSON Meta

Defined in Network.JSONApi.Meta

Methods

toJSON :: Meta -> Value

toEncoding :: Meta -> Encoding

toJSONList :: [Meta] -> Value

toEncodingList :: [Meta] -> Encoding

FromJSON Meta

Defined in Network.JSONApi.Meta

Methods

parseJSON :: Value -> Parser Meta

parseJSONList :: Value -> Parser [Meta]

NFData Meta

Defined in Network.JSONApi.Meta

Methods

rnf :: Meta -> ()

type Rep Meta

Defined in Network.JSONApi.Meta

type Rep Meta = D1 (MetaData "Meta" "Network.JSONApi.Meta" "json-api-lib-0.1.3.0-6YcBiX2ASZQ3iU3wpNCPjK" True) (C1 (MetaCons "Meta" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Object)))

class ToJSON a => MetaObject a where

Convienience class for constructing a Meta type

Example usage: @ data Pagination = Pagination { currentPage :: Int , totalPages :: Int } deriving (Show, Generic)

instance ToJSON Pagination instance MetaObject Pagination where typeName _ = "pagination" @

Methods

typeName :: a -> Text

Instances

MetaObject Pagination

Pagination can be used as a meta object if required in addition to the links generated for paging.

Defined in Network.JSONApi.Pagination

Methods

typeName :: Pagination -> Text

mkMeta :: MetaObject a => a -> Meta

Convienience constructor function for the Meta type

Useful on its own or in combination with Meta's monoid instance

Example usage: See MetaSpec.hs for an example