Safe Haskell	None
Language	Haskell2010

Network.JSONApi.Identifier

Description

Module representing a JSON-API resource object.

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

Synopsis

class HasIdentifier a where
- identifier :: a -> Identifier
data Identifier = Identifier {
- _ident :: Text
- _datatype :: Text
- _metadata :: Maybe Meta
}
datatype :: Lens' Identifier Text
ident :: Lens' Identifier Text
metadata :: Lens' Identifier (Maybe Meta)

Documentation

class HasIdentifier a where Source #

Typeclass indicating how to access an Identifier for a given datatype

Methods

identifier :: a -> Identifier Source #

Instances

HasIdentifier (Resource a) Source #
Instance details Defined in Network.JSONApi.Resource Methods identifier :: Resource a -> Identifier Source #

data Identifier Source #

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 _ident :: Text _datatype :: Text _metadata :: Maybe Meta

Instances

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

datatype :: Lens' Identifier Text Source #

ident :: Lens' Identifier Text Source #

metadata :: Lens' Identifier (Maybe Meta) Source #