Safe Haskell	None
Language	Haskell2010

Network.JSONApi.Document

Description

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

Synopsis

data Document a
data ResourceData a
- = Singleton (Resource a)
- | List [Resource a]
data ErrorDocument a = ErrorDocument {
- _error :: Error a
- _errorLinks :: Maybe Links
- _errorMeta :: Maybe Meta
}
data Included
mkDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Document a
mkDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Document a
singleton :: ResourcefulEntity a => a -> ResourceData a
list :: ResourcefulEntity a => [a] -> ResourceData a
mkCompoundDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Included -> Document a
mkCompoundDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Included -> Document a
mkIncludedResource :: ResourcefulEntity a => a -> Included

Documentation

data Document a Source #

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

Instances

Eq a => Eq (Document a) Source #
Instance details Defined in Network.JSONApi.Document Methods (==) :: Document a -> Document a -> Bool # (/=) :: Document a -> Document a -> Bool #
Show a => Show (Document a) Source #
Instance details Defined in Network.JSONApi.Document Methods showsPrec :: Int -> Document a -> ShowS # show :: Document a -> String # showList :: [Document a] -> ShowS #
Generic (Document a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Network.JSONApi.Document Methods parseJSON :: Value -> Parser (Document a) # parseJSONList :: Value -> Parser [Document a] #
type Rep (Document a) Source #
Instance details Defined in Network.JSONApi.Document type Rep (Document a) = D1 (MetaData "Document" "Network.JSONApi.Document" "json-api-lib-0.1.0.0-45NC2ZPdb2dLcmSQF2fcQg" 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 Source #

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) Source #
Instance details Defined in Network.JSONApi.Document Methods (==) :: ResourceData a -> ResourceData a -> Bool # (/=) :: ResourceData a -> ResourceData a -> Bool #
Show a => Show (ResourceData a) Source #
Instance details Defined in Network.JSONApi.Document Methods showsPrec :: Int -> ResourceData a -> ShowS # show :: ResourceData a -> String # showList :: [ResourceData a] -> ShowS #
Generic (ResourceData a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Network.JSONApi.Document Methods parseJSON :: Value -> Parser (ResourceData a) # parseJSONList :: Value -> Parser [ResourceData a] #
type Rep (ResourceData a) Source #
Instance details Defined in Network.JSONApi.Document type Rep (ResourceData a) = D1 (MetaData "ResourceData" "Network.JSONApi.Document" "json-api-lib-0.1.0.0-45NC2ZPdb2dLcmSQF2fcQg" 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 Source #

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) Source #
Instance details Defined in Network.JSONApi.Document Methods (==) :: ErrorDocument a -> ErrorDocument a -> Bool # (/=) :: ErrorDocument a -> ErrorDocument a -> Bool #
Show (ErrorDocument a) Source #
Instance details Defined in Network.JSONApi.Document Methods showsPrec :: Int -> ErrorDocument a -> ShowS # show :: ErrorDocument a -> String # showList :: [ErrorDocument a] -> ShowS #
Generic (ErrorDocument a) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Network.JSONApi.Document Methods parseJSON :: Value -> Parser (ErrorDocument a) # parseJSONList :: Value -> Parser [ErrorDocument a] #
type Rep (ErrorDocument a) Source #
Instance details Defined in Network.JSONApi.Document type Rep (ErrorDocument a) = D1 (MetaData "ErrorDocument" "Network.JSONApi.Document" "json-api-lib-0.1.0.0-45NC2ZPdb2dLcmSQF2fcQg" 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 Source #

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 Source #
Instance details Defined in Network.JSONApi.Document Methods showsPrec :: Int -> Included -> ShowS # show :: Included -> String # showList :: [Included] -> ShowS #

mkDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Document a Source #

Constructor function for the Document data type.

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

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

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

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

mkCompoundDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Included -> Document a Source #

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 Source #

mkIncludedResource :: ResourcefulEntity a => a -> Included Source #

Constructor function for the Document data type.

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