Network.JSONApi.Identifier

Module representing a JSON-API resource object.

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

Documentation

class HasIdentifier a where

Typeclass indicating how to access an Identifier for a given datatype

Methods

identifier :: a -> Identifier

Instances

HasIdentifier (Resource a)

Defined in Network.JSONApi.Resource

Methods

identifier :: Resource a -> Identifier

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

• _ident :: Text
• _datatype :: Text
• _metadata :: Maybe Meta

Instances

Eq Identifier

Defined in Network.JSONApi.Identifier

Methods

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

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

Show Identifier

Defined in Network.JSONApi.Identifier

Methods

showsPrec :: Int -> Identifier -> ShowS

show :: Identifier -> String

showList :: [Identifier] -> ShowS

ToJSON Identifier

Defined in Network.JSONApi.Identifier

Methods

toJSON :: Identifier -> Value

toEncoding :: Identifier -> Encoding

toJSONList :: [Identifier] -> Value

toEncodingList :: [Identifier] -> Encoding

FromJSON Identifier

Defined in Network.JSONApi.Identifier

Methods

parseJSON :: Value -> Parser Identifier

parseJSONList :: Value -> Parser [Identifier]

datatype :: Lens' Identifier Text

ident :: Lens' Identifier Text

metadata :: Lens' Identifier (Maybe Meta)