Safe Haskell	None
Language	Haskell2010

Network.JSONApi.Resource

Description

Module representing a JSON-API resource object.

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

Synopsis

data Resource a = Resource {
- getIdentifier :: Identifier
- getResource :: a
- getLinks :: Maybe Links
- getRelationships :: Maybe Relationships
}
data Relationships
class (ToJSON a, FromJSON a) => ResourcefulEntity a where
- resourceIdentifier :: a -> Text
- resourceType :: a -> Text
- resourceLinks :: a -> Maybe Links
- resourceMetaData :: a -> Maybe Meta
- resourceRelationships :: a -> Maybe Relationships
- fromResource :: Resource a -> a
- toResource :: a -> Resource a
data Relationship
indexLinks :: Text -> Pagination -> Links
mkRelationship :: Maybe Identifier -> Maybe Links -> Maybe Relationship
mkRelationships :: Relationship -> Relationships
showLink :: ResourcefulEntity e => e -> Links

Documentation

data Resource a Source #

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 getRelationships :: Maybe Relationships

Instances

Eq a => Eq (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods (==) :: Resource a -> Resource a -> Bool # (/=) :: Resource a -> Resource a -> Bool #
Show a => Show (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods showsPrec :: Int -> Resource a -> ShowS # show :: Resource a -> String # showList :: [Resource a] -> ShowS #
Generic (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Associated Types type Rep (Resource a) :: Type -> Type # Methods from :: Resource a -> Rep (Resource a) x # to :: Rep (Resource a) x -> Resource a #
ToJSON a => ToJSON (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods toJSON :: Resource a -> Value # toEncoding :: Resource a -> Encoding # toJSONList :: [Resource a] -> Value # toEncodingList :: [Resource a] -> Encoding #
FromJSON a => FromJSON (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods parseJSON :: Value -> Parser (Resource a) # parseJSONList :: Value -> Parser [Resource a] #
NFData a => NFData (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods rnf :: Resource a -> () #
HasIdentifier (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods identifier :: Resource a -> Identifier Source #
type Rep (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource type Rep (Resource a) = D1 (MetaData "Resource" "Network.JSONApi.Resource" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" False) (C1 (MetaCons "Resource" PrefixI True) ((S1 (MetaSel (Just "getIdentifier") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Identifier) :: S1 (MetaSel (Just "getResource") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) :: (S1 (MetaSel (Just "getLinks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links)) :*: S1 (MetaSel (Just "getRelationships") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Relationships)))))

data Relationships Source #

Instances

Eq Relationships Source #
Instance details Defined in Network.JSONApi.Resource Methods (==) :: Relationships -> Relationships -> Bool # (/=) :: Relationships -> Relationships -> Bool #
Show Relationships Source #
Instance details Defined in Network.JSONApi.Resource Methods showsPrec :: Int -> Relationships -> ShowS # show :: Relationships -> String # showList :: [Relationships] -> ShowS #
Generic Relationships Source #
Instance details Defined in Network.JSONApi.Resource Associated Types type Rep Relationships :: Type -> Type # Methods from :: Relationships -> Rep Relationships x # to :: Rep Relationships x -> Relationships #
ToJSON Relationships Source #
Instance details Defined in Network.JSONApi.Resource Methods toJSON :: Relationships -> Value # toEncoding :: Relationships -> Encoding # toJSONList :: [Relationships] -> Value # toEncodingList :: [Relationships] -> Encoding #
FromJSON Relationships Source #
Instance details Defined in Network.JSONApi.Resource Methods parseJSON :: Value -> Parser Relationships # parseJSONList :: Value -> Parser [Relationships] #
NFData Relationships Source #
Instance details Defined in Network.JSONApi.Resource Methods rnf :: Relationships -> () #
type Rep Relationships Source #
Instance details Defined in Network.JSONApi.Resource type Rep Relationships = D1 (MetaData "Relationships" "Network.JSONApi.Resource" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" True) (C1 (MetaCons "Relationships" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text Relationship))))

class (ToJSON a, FromJSON a) => ResourcefulEntity a where Source #

A typeclass for decorating an entity with JSON API properties

Minimal complete definition

resourceIdentifier, resourceType, resourceLinks, resourceMetaData, resourceRelationships

Methods

resourceIdentifier :: a -> Text Source #

resourceType :: a -> Text Source #

resourceLinks :: a -> Maybe Links Source #

resourceMetaData :: a -> Maybe Meta Source #

resourceRelationships :: a -> Maybe Relationships Source #

fromResource :: Resource a -> a Source #

toResource :: a -> Resource a Source #

data Relationship Source #

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 Source #
Instance details Defined in Network.JSONApi.Resource Methods (==) :: Relationship -> Relationship -> Bool # (/=) :: Relationship -> Relationship -> Bool #
Show Relationship Source #
Instance details Defined in Network.JSONApi.Resource Methods showsPrec :: Int -> Relationship -> ShowS # show :: Relationship -> String # showList :: [Relationship] -> ShowS #
Generic Relationship Source #
Instance details Defined in Network.JSONApi.Resource Associated Types type Rep Relationship :: Type -> Type # Methods from :: Relationship -> Rep Relationship x # to :: Rep Relationship x -> Relationship #
ToJSON Relationship Source #
Instance details Defined in Network.JSONApi.Resource Methods toJSON :: Relationship -> Value # toEncoding :: Relationship -> Encoding # toJSONList :: [Relationship] -> Value # toEncodingList :: [Relationship] -> Encoding #
FromJSON Relationship Source #
Instance details Defined in Network.JSONApi.Resource Methods parseJSON :: Value -> Parser Relationship # parseJSONList :: Value -> Parser [Relationship] #
NFData Relationship Source #
Instance details Defined in Network.JSONApi.Resource Methods rnf :: Relationship -> () #
type Rep Relationship Source #
Instance details Defined in Network.JSONApi.Resource type Rep Relationship = D1 (MetaData "Relationship" "Network.JSONApi.Resource" "json-api-lib-0.2.0.0-CIYDoTtBA9V1pU3j2B9t69" False) (C1 (MetaCons "Relationship" PrefixI True) (S1 (MetaSel (Just "_data") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Identifier)) :*: S1 (MetaSel (Just "_links") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Links))))

indexLinks :: Text -> Pagination -> Links Source #

Helper function to beuild relative links for a collection of resources of type ResourceEntity.

This helper function assumes that the first page is always page 0.

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

Constructor function for creating a Relationship record

A relationship must contain either an Identifier or a Links record

mkRelationships :: Relationship -> Relationships Source #

showLink :: ResourcefulEntity e => e -> Links Source #

Helper function to build relative links for a single resource of type ResourceEntity