Network.JSONApi.Document

Contains representations of the top-level JSON-API document structure.

Documentation

data Document a

The Document type represents the top-level JSON-API requirement.

data attribute - the resulting JSON may be either a singleton resource or a list of resources. See Resource for the construction.

For more information see: http://jsonapi.org/format/#document-top-level

Constructors

Document

Fields

• _data :: ResourceData a
• _links :: Maybe Links
• _meta :: Maybe Meta
• _included :: [Value]

Instances

Eq a => Eq (Document a)

Defined in Network.JSONApi.Document

Methods

(==) :: Document a -> Document a -> Bool

(/=) :: Document a -> Document a -> Bool

Show a => Show (Document a)

Defined in Network.JSONApi.Document

Methods

showsPrec :: Int -> Document a -> ShowS

show :: Document a -> String

showList :: [Document a] -> ShowS

Generic (Document a)

Defined in Network.JSONApi.Document

Associated Types

type Rep (Document a) :: Type -> Type

Methods

from :: Document a -> Rep (Document a) x

to :: Rep (Document a) x -> Document a

ToJSON a => ToJSON (Document a)

Defined in Network.JSONApi.Document

Methods

toJSON :: Document a -> Value

toEncoding :: Document a -> Encoding

toJSONList :: [Document a] -> Value

toEncodingList :: [Document a] -> Encoding

FromJSON a => FromJSON (Document a)

Defined in Network.JSONApi.Document

Methods

parseJSON :: Value -> Parser (Document a)

parseJSONList :: Value -> Parser [Document a]

NFData a => NFData (Document a)

Defined in Network.JSONApi.Document

Methods

rnf :: Document a -> ()

type Rep (Document a)

Defined in Network.JSONApi.Document

type Rep (Document a) = D1 (MetaData "Document" "Network.JSONApi.Document" "json-api-lib-0.3.0.0-EA1mdVZ1o5NJWsxzWCLCdF" False) (C1 (MetaCons "Document" PrefixI True) ((S1 (MetaSel (Just "_data") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ResourceData a)) :*: S1 (MetaSel (Just "_links") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links))) :*: (S1 (MetaSel (Just "_meta") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Meta)) :*: S1 (MetaSel (Just "_included") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Value]))))

data ResourceData a

The Resource type encapsulates the underlying Resource

Included in the top-level Document, the Resource may be either a singleton resource or a list.

For more information see: http://jsonapi.org/format/#document-top-level

Constructors

Singleton (Resource a)

List [Resource a]

Instances

Eq a => Eq (ResourceData a)

Defined in Network.JSONApi.Document

Methods

(==) :: ResourceData a -> ResourceData a -> Bool

(/=) :: ResourceData a -> ResourceData a -> Bool

Show a => Show (ResourceData a)

Defined in Network.JSONApi.Document

Methods

showsPrec :: Int -> ResourceData a -> ShowS

show :: ResourceData a -> String

showList :: [ResourceData a] -> ShowS

Generic (ResourceData a)

Defined in Network.JSONApi.Document

Associated Types

type Rep (ResourceData a) :: Type -> Type

Methods

from :: ResourceData a -> Rep (ResourceData a) x

to :: Rep (ResourceData a) x -> ResourceData a

ToJSON a => ToJSON (ResourceData a)

Defined in Network.JSONApi.Document

Methods

toJSON :: ResourceData a -> Value

toEncoding :: ResourceData a -> Encoding

toJSONList :: [ResourceData a] -> Value

toEncodingList :: [ResourceData a] -> Encoding

FromJSON a => FromJSON (ResourceData a)

Defined in Network.JSONApi.Document

Methods

parseJSON :: Value -> Parser (ResourceData a)

parseJSONList :: Value -> Parser [ResourceData a]

NFData a => NFData (ResourceData a)

Defined in Network.JSONApi.Document

Methods

rnf :: ResourceData a -> ()

type Rep (ResourceData a)

Defined in Network.JSONApi.Document

type Rep (ResourceData a) = D1 (MetaData "ResourceData" "Network.JSONApi.Document" "json-api-lib-0.3.0.0-EA1mdVZ1o5NJWsxzWCLCdF" False) (C1 (MetaCons "Singleton" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Resource a))) :+: C1 (MetaCons "List" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Resource a])))

data ErrorDocument a

The ErrorDocument type represents the alternative form of the top-level JSON-API requirement.

error attribute - a descriptive object encapsulating application-specific error detail.

For more information see: http://jsonapi.org/format/#errors

Constructors

ErrorDocument

Fields

• _error :: Error a
• _errorLinks :: Maybe Links
• _errorMeta :: Maybe Meta

Instances

Eq (ErrorDocument a)

Defined in Network.JSONApi.Document

Methods

(==) :: ErrorDocument a -> ErrorDocument a -> Bool

(/=) :: ErrorDocument a -> ErrorDocument a -> Bool

Show (ErrorDocument a)

Defined in Network.JSONApi.Document

Methods

showsPrec :: Int -> ErrorDocument a -> ShowS

show :: ErrorDocument a -> String

showList :: [ErrorDocument a] -> ShowS

Generic (ErrorDocument a)

Defined in Network.JSONApi.Document

Associated Types

type Rep (ErrorDocument a) :: Type -> Type

Methods

from :: ErrorDocument a -> Rep (ErrorDocument a) x

to :: Rep (ErrorDocument a) x -> ErrorDocument a

ToJSON a => ToJSON (ErrorDocument a)

Defined in Network.JSONApi.Document

Methods

toJSON :: ErrorDocument a -> Value

toEncoding :: ErrorDocument a -> Encoding

toJSONList :: [ErrorDocument a] -> Value

toEncodingList :: [ErrorDocument a] -> Encoding

FromJSON a => FromJSON (ErrorDocument a)

Defined in Network.JSONApi.Document

Methods

parseJSON :: Value -> Parser (ErrorDocument a)

parseJSONList :: Value -> Parser [ErrorDocument a]

NFData a => NFData (ErrorDocument a)

Defined in Network.JSONApi.Document

Methods

rnf :: ErrorDocument a -> ()

type Rep (ErrorDocument a)

Defined in Network.JSONApi.Document

type Rep (ErrorDocument a) = D1 (MetaData "ErrorDocument" "Network.JSONApi.Document" "json-api-lib-0.3.0.0-EA1mdVZ1o5NJWsxzWCLCdF" False) (C1 (MetaCons "ErrorDocument" PrefixI True) (S1 (MetaSel (Just "_error") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Error a)) :*: (S1 (MetaSel (Just "_errorLinks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links)) :*: S1 (MetaSel (Just "_errorMeta") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Meta)))))

data Included

The Included type is an abstraction used to constrain the included section of the Document to JSON serializable Resource objects while enabling a heterogeneous list of Resource types.

No data constructors for this type are exported as we need to constrain the Value to a heterogeneous list of Resource types. See mkIncludedResource for creating Included types.

Instances

Show Included

Defined in Network.JSONApi.Document

Methods

showsPrec :: Int -> Included -> ShowS

show :: Included -> String

showList :: [Included] -> ShowS

Generic Included

Defined in Network.JSONApi.Document

Associated Types

type Rep Included :: Type -> Type

Methods

from :: Included -> Rep Included x

to :: Rep Included x -> Included

NFData Included

Defined in Network.JSONApi.Document

Methods

rnf :: Included -> ()

type Rep Included

Defined in Network.JSONApi.Document

type Rep Included = D1 (MetaData "Included" "Network.JSONApi.Document" "json-api-lib-0.3.0.0-EA1mdVZ1o5NJWsxzWCLCdF" True) (C1 (MetaCons "Included" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Value])))

mkDocument :: ResourcefulEntity a => a -> Maybe Links -> Maybe Meta -> Document a

Constructor function for the Document data type which takes a single ResourcefulEntity.

See mkCompoundDocument for constructing compound Document including 'side-loaded' resources

mkDocuments :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Document a

Constructor function for the Document data type which takes a list of Resourceful entities.

See mkCompoundDocument for constructing compound Document including 'side-loaded' resources

mkDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Document a

mkSimpleDocument :: ResourcefulEntity a => a -> Document a

A function for a single resourceful entity and document which do not require links or Meta data.

mkSimpleDocuments :: ResourcefulEntity a => [a] -> Document a

A function for a multiple resourceful entities and document which do not require links or Meta data.

mkSimpleDocument' :: ResourceData a -> Document a

A function for document which do not require links or Meta data.

singleton :: ResourcefulEntity a => a -> ResourceData a

list :: ResourcefulEntity a => [a] -> ResourceData a

mkCompoundDocument :: ResourcefulEntity a => a -> Maybe Links -> Maybe Meta -> Included -> Document a

Constructor function for the Document data type. See mkIncludedResource for constructing the Included type.

Supports building compound documents http://jsonapi.org/format/#document-compound-documents

mkCompoundDocuments :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Included -> Document a

Constructor function for the Document data type. See mkIncludedResource for constructing the Included type.

Supports building compound documents http://jsonapi.org/format/#document-compound-documents

mkCompoundDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Included -> Document a

mkIncludedResource :: (ResourcefulEntity a, ToJSON a) => a -> Included

Constructor function for the Document data type.

Supports building compound documents http://jsonapi.org/format/#document-compound-documents