Network.JSONApi.Resource

Module representing a JSON-API resource object.

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

Documentation

data Identifier

Identifiers are used to encapsulate the minimum amount of information to uniquely identify a resource.

This object will be found at multiple levels of the JSON-API structure

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

Constructors

Identifier

Fields

• _id :: Text
• _type :: Text

Instances

Eq Identifier

Methods

(==) :: Identifier -> Identifier -> Bool

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

Show Identifier

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

Generic Identifier

Associated Types

type Rep Identifier :: * -> *

Methods

from :: Identifier -> Rep Identifier x

to :: Rep Identifier x -> Identifier

ToJSON Identifier

Methods

toJSON :: Identifier -> Value

toEncoding :: Identifier -> Encoding

FromJSON Identifier

Methods

parseJSON :: Value -> Parser Identifier

type Rep Identifier

type Rep Identifier = D1 (MetaData "Identifier" "Network.JSONApi.Resource" "json-api-0.1.0.4-XQJNxt8UE1JTVw5IChpYb" False) (C1 (MetaCons "Identifier" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_type") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

data Resource a b

Type representing a JSON-API resource object.

A Resource supplies standardized data and metadata about a resource.

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

Constructors

Resource

Fields

• getIdentifier :: Identifier
• getResource :: a
• getLinks :: Maybe Links
• getMetaData :: Maybe (Meta b)
• getRelationships :: Maybe (Map Text Relationship)

Instances

(Eq a, Eq b) => Eq (Resource a b)

Methods

(==) :: Resource a b -> Resource a b -> Bool

(/=) :: Resource a b -> Resource a b -> Bool

(Show a, Show b) => Show (Resource a b)

Methods

showsPrec :: Int -> Resource a b -> ShowS

show :: Resource a b -> String

showList :: [Resource a b] -> ShowS

Generic (Resource a b)

Associated Types

type Rep (Resource a b) :: * -> *

Methods

from :: Resource a b -> Rep (Resource a b) x

to :: Rep (Resource a b) x -> Resource a b

(ToJSON a, ToJSON b) => ToJSON (Resource a b)

Methods

toJSON :: Resource a b -> Value

toEncoding :: Resource a b -> Encoding

(FromJSON a, FromJSON b) => FromJSON (Resource a b)

Methods

parseJSON :: Value -> Parser (Resource a b)

type Rep (Resource a b)

type Rep (Resource a b) = D1 (MetaData "Resource" "Network.JSONApi.Resource" "json-api-0.1.0.4-XQJNxt8UE1JTVw5IChpYb" False) (C1 (MetaCons "Resource" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "getIdentifier") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Identifier)) (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)))) (S1 (MetaSel (Just Symbol "getRelationships") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Map Text Relationship))))))))

data Relationship

A type representing the Relationship between 2 entities

A Relationship provides basic information for fetching further information about a related resource.

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

Instances

Eq Relationship

Methods

(==) :: Relationship -> Relationship -> Bool

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

Show Relationship

Methods

showsPrec :: Int -> Relationship -> ShowS

show :: Relationship -> String

showList :: [Relationship] -> ShowS

Generic Relationship

Associated Types

type Rep Relationship :: * -> *

Methods

from :: Relationship -> Rep Relationship x

to :: Rep Relationship x -> Relationship

ToJSON Relationship

Methods

toJSON :: Relationship -> Value

toEncoding :: Relationship -> Encoding

FromJSON Relationship

Methods

parseJSON :: Value -> Parser Relationship

type Rep Relationship

type Rep Relationship = D1 (MetaData "Relationship" "Network.JSONApi.Resource" "json-api-0.1.0.4-XQJNxt8UE1JTVw5IChpYb" False) (C1 (MetaCons "Relationship" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_data") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Identifier))) (S1 (MetaSel (Just Symbol "_links") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links)))))

mkRelationship :: Maybe Identifier -> Maybe Links -> Maybe Relationship

Constructor function for creating a Relationship record

A relationship must contain either an Identifier or a Links record