Safe Haskell	None
Language	Haskell2010

Network.JSONApi.ResourceObject

Description

Module representing a JSON-API resource object.

Specification: http://jsonapi.org/format/#document-resource-objects

Synopsis

Documentation

newtype ResourceId Source #

Constructors

ResourceId Text

Instances

Eq ResourceId Source #
Methods (==) :: ResourceId -> ResourceId -> Bool # (/=) :: ResourceId -> ResourceId -> Bool #
Ord ResourceId Source #
Methods compare :: ResourceId -> ResourceId -> Ordering # (<) :: ResourceId -> ResourceId -> Bool # (<=) :: ResourceId -> ResourceId -> Bool # (>) :: ResourceId -> ResourceId -> Bool # (>=) :: ResourceId -> ResourceId -> Bool # max :: ResourceId -> ResourceId -> ResourceId # min :: ResourceId -> ResourceId -> ResourceId #
Show ResourceId Source #
Methods showsPrec :: Int -> ResourceId -> ShowS # show :: ResourceId -> String # showList :: [ResourceId] -> ShowS #
Generic ResourceId Source #
Associated Types type Rep ResourceId :: * -> * # Methods from :: ResourceId -> Rep ResourceId x # to :: Rep ResourceId x -> ResourceId #
ToJSON ResourceId Source #
Methods toJSON :: ResourceId -> Value # toEncoding :: ResourceId -> Encoding #
FromJSON ResourceId Source #
Methods parseJSON :: Value -> Parser ResourceId #
type Rep ResourceId Source #
type Rep ResourceId = D1 (MetaData "ResourceId" "Network.JSONApi.ResourceObject" "json-api-0.1.0.3-8h2btQIKCdWLvJ0S8gWQEo" True) (C1 (MetaCons "ResourceId" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data ResourceObject a b Source #

Type representing a JSON-API resource object.

A ResourceObject supplies standardized data and metadata about a resource.

Specification: http://jsonapi.org/format/#document-resource-objects

Constructors

ResourceObject
Fields getResourceId :: ResourceId getResourceType :: ResourceType getResource :: a getLinks :: Maybe Links getMetaData :: Maybe (Meta b)

Instances

(Eq b, Eq a) => Eq (ResourceObject a b) Source #
Methods (==) :: ResourceObject a b -> ResourceObject a b -> Bool # (/=) :: ResourceObject a b -> ResourceObject a b -> Bool #
(Ord b, Ord a) => Ord (ResourceObject a b) Source #
Methods compare :: ResourceObject a b -> ResourceObject a b -> Ordering # (<) :: ResourceObject a b -> ResourceObject a b -> Bool # (<=) :: ResourceObject a b -> ResourceObject a b -> Bool # (>) :: ResourceObject a b -> ResourceObject a b -> Bool # (>=) :: ResourceObject a b -> ResourceObject a b -> Bool # max :: ResourceObject a b -> ResourceObject a b -> ResourceObject a b # min :: ResourceObject a b -> ResourceObject a b -> ResourceObject a b #
(Show b, Show a) => Show (ResourceObject a b) Source #
Methods showsPrec :: Int -> ResourceObject a b -> ShowS # show :: ResourceObject a b -> String # showList :: [ResourceObject a b] -> ShowS #
Generic (ResourceObject a b) Source #
Associated Types type Rep (ResourceObject a b) :: * -> * # Methods from :: ResourceObject a b -> Rep (ResourceObject a b) x # to :: Rep (ResourceObject a b) x -> ResourceObject a b #
(ToJSON a, ToJSON b) => ToJSON (ResourceObject a b) Source #
Methods toJSON :: ResourceObject a b -> Value # toEncoding :: ResourceObject a b -> Encoding #
(FromJSON a, FromJSON b) => FromJSON (ResourceObject a b) Source #
Methods parseJSON :: Value -> Parser (ResourceObject a b) #
type Rep (ResourceObject a b) Source #
type Rep (ResourceObject a b) = D1 (MetaData "ResourceObject" "Network.JSONApi.ResourceObject" "json-api-0.1.0.3-8h2btQIKCdWLvJ0S8gWQEo" False) (C1 (MetaCons "ResourceObject" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "getResourceId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ResourceId)) (S1 (MetaSel (Just Symbol "getResourceType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ResourceType))) ((::) (S1 (MetaSel (Just Symbol "getResource") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) ((::) (S1 (MetaSel (Just Symbol "getLinks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links))) (S1 (MetaSel (Just Symbol "getMetaData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Meta b))))))))

newtype ResourceType Source #

Constructors

ResourceType Text

Instances

Eq ResourceType Source #
Methods (==) :: ResourceType -> ResourceType -> Bool # (/=) :: ResourceType -> ResourceType -> Bool #
Ord ResourceType Source #
Methods compare :: ResourceType -> ResourceType -> Ordering # (<) :: ResourceType -> ResourceType -> Bool # (<=) :: ResourceType -> ResourceType -> Bool # (>) :: ResourceType -> ResourceType -> Bool # (>=) :: ResourceType -> ResourceType -> Bool # max :: ResourceType -> ResourceType -> ResourceType # min :: ResourceType -> ResourceType -> ResourceType #
Show ResourceType Source #
Methods showsPrec :: Int -> ResourceType -> ShowS # show :: ResourceType -> String # showList :: [ResourceType] -> ShowS #
Generic ResourceType Source #
Associated Types type Rep ResourceType :: * -> * # Methods from :: ResourceType -> Rep ResourceType x # to :: Rep ResourceType x -> ResourceType #
ToJSON ResourceType Source #
Methods toJSON :: ResourceType -> Value # toEncoding :: ResourceType -> Encoding #
FromJSON ResourceType Source #
Methods parseJSON :: Value -> Parser ResourceType #
type Rep ResourceType Source #
type Rep ResourceType = D1 (MetaData "ResourceType" "Network.JSONApi.ResourceObject" "json-api-0.1.0.3-8h2btQIKCdWLvJ0S8gWQEo" True) (C1 (MetaCons "ResourceType" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))