Copyright	(c) Alex Brandt 2017
License	MIT
Safe Haskell	None
Language	Haskell2010

Data.SirenJSON

Contents

Core Data Types
Type Conversion

Description

A collection of types and instances for application/vnd.siren+json.

Full documentation for application/vnd.siren+json can be found at https://github.com/kevinswiber/siren.

Synopsis

data Entity = Entity {
- eClass :: [Text]
- eProperties :: Map Text Text
- eEntities :: [SubEntity]
- eLinks :: [Link]
- eActions :: [Action]
- eTitle :: Maybe Text
}
data SubEntity
- = EmbeddedLink Link
- | EmbeddedRepresentation {
  - sEntity :: Entity
  - sRel :: [Text]
  }
data Link = Link {
- lClass :: [Text]
- lRel :: [Text]
- lHref :: URI
- lType :: Maybe MediaType
- lTitle :: Maybe Text
}
data Action = Action {
- aName :: Text
- aClass :: [Text]
- aMethod :: Maybe StdMethod
- aHref :: URI
- aTitle :: Maybe Text
- aType :: Maybe MediaType
- aFields :: [Field]
}
data Field = Field {
- fName :: Text
- fClass :: [Text]
- fType :: Maybe InputType
- fValue :: Maybe Text
- fTitle :: Maybe Text
}
data InputType
- = Hidden
- | Text
- | Search
- | Tel
- | URL
- | Email
- | Password
- | DateTime
- | Date
- | Month
- | Week
- | Time
- | DateTimeLocal
- | Number
- | Range
- | Color
- | CheckBox
- | Radio
- | File
class FromEntity a where
- fromEntity :: Entity -> a
class ToEntity a where
- toEntity :: a -> Entity

Core Data Types

data Entity Source #

The top-level object for an application/vnd.siren+json resource.

Constructors

Entity
Fields eClass :: [Text] Nature of `Entity'`s content---implementation dependant and should be documented eProperties :: Map Text Text `Entity` state as key-value pairs---we encode all values as strings for simplicity and to allow parsing into other types as needed eEntities :: [SubEntity] eLinks :: [Link] eActions :: [Action] eTitle :: Maybe Text Descriptive text about `Entity`

Instances

Eq Entity Source #
Instance details Defined in Data.SirenJSON Methods (==) :: Entity -> Entity -> Bool # (/=) :: Entity -> Entity -> Bool #
Show Entity Source #
Instance details Defined in Data.SirenJSON Methods showsPrec :: Int -> Entity -> ShowS # show :: Entity -> String # showList :: [Entity] -> ShowS #
ToJSON Entity Source #
Instance details Defined in Data.SirenJSON Methods toJSON :: Entity -> Value # toEncoding :: Entity -> Encoding # toJSONList :: [Entity] -> Value # toEncodingList :: [Entity] -> Encoding #
FromJSON Entity Source #
Instance details Defined in Data.SirenJSON Methods parseJSON :: Value -> Parser Entity # parseJSONList :: Value -> Parser [Entity] #

data SubEntity Source #

Nested object for an application/vnd.siren+json.

Constructors

EmbeddedLink Link
EmbeddedRepresentation
Fields sEntity :: Entity sRel :: [Text]

Instances

Eq SubEntity Source #
Instance details Defined in Data.SirenJSON Methods (==) :: SubEntity -> SubEntity -> Bool # (/=) :: SubEntity -> SubEntity -> Bool #
Show SubEntity Source #
Instance details Defined in Data.SirenJSON Methods showsPrec :: Int -> SubEntity -> ShowS # show :: SubEntity -> String # showList :: [SubEntity] -> ShowS #
ToJSON SubEntity Source #
Instance details Defined in Data.SirenJSON Methods toJSON :: SubEntity -> Value # toEncoding :: SubEntity -> Encoding # toJSONList :: [SubEntity] -> Value # toEncodingList :: [SubEntity] -> Encoding #
FromJSON SubEntity Source #
Instance details Defined in Data.SirenJSON Methods parseJSON :: Value -> Parser SubEntity # parseJSONList :: Value -> Parser [SubEntity] #

data Link Source #

Link to a related resource.

Constructors

Link
Fields lClass :: [Text] Nature of `Entity'`s content--- implementation dependant and should be documented lRel :: [Text] lHref :: URI lType :: Maybe MediaType lTitle :: Maybe Text

Instances

Eq Link Source #
Instance details Defined in Data.SirenJSON Methods (==) :: Link -> Link -> Bool # (/=) :: Link -> Link -> Bool #
Show Link Source #
Instance details Defined in Data.SirenJSON Methods showsPrec :: Int -> Link -> ShowS # show :: Link -> String # showList :: [Link] -> ShowS #
ToJSON Link Source #
Instance details Defined in Data.SirenJSON Methods toJSON :: Link -> Value # toEncoding :: Link -> Encoding # toJSONList :: [Link] -> Value # toEncodingList :: [Link] -> Encoding #
FromJSON Link Source #
Instance details Defined in Data.SirenJSON Methods parseJSON :: Value -> Parser Link # parseJSONList :: Value -> Parser [Link] #

data Action Source #

Behavior of an Entity.

Constructors

Action
Fields aName :: Text aClass :: [Text] aMethod :: Maybe StdMethod aHref :: URI aTitle :: Maybe Text aType :: Maybe MediaType aFields :: [Field]

Instances

Eq Action Source #
Instance details Defined in Data.SirenJSON Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Show Action Source #
Instance details Defined in Data.SirenJSON Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
ToJSON Action Source #
Instance details Defined in Data.SirenJSON Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
FromJSON Action Source #
Instance details Defined in Data.SirenJSON Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #

data Field Source #

Control inside of an Action.

Constructors

Field
Fields fName :: Text fClass :: [Text] fType :: Maybe InputType fValue :: Maybe Text fTitle :: Maybe Text

Instances

Eq Field Source #
Instance details Defined in Data.SirenJSON Methods (==) :: Field -> Field -> Bool # (/=) :: Field -> Field -> Bool #
Show Field Source #
Instance details Defined in Data.SirenJSON Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #
ToJSON Field Source #
Instance details Defined in Data.SirenJSON Methods toJSON :: Field -> Value # toEncoding :: Field -> Encoding # toJSONList :: [Field] -> Value # toEncodingList :: [Field] -> Encoding #
FromJSON Field Source #
Instance details Defined in Data.SirenJSON Methods parseJSON :: Value -> Parser Field # parseJSONList :: Value -> Parser [Field] #

data InputType Source #

Constructors

Hidden
Text
Search
Tel
URL
Email
Password
DateTime
Date
Month
Week
Time
DateTimeLocal
Number
Range
Color
CheckBox
Radio
File

Instances

Eq InputType Source #
Instance details Defined in Data.SirenJSON Methods (==) :: InputType -> InputType -> Bool # (/=) :: InputType -> InputType -> Bool #
Show InputType Source #
Instance details Defined in Data.SirenJSON Methods showsPrec :: Int -> InputType -> ShowS # show :: InputType -> String # showList :: [InputType] -> ShowS #
ToJSON InputType Source #
Instance details Defined in Data.SirenJSON Methods toJSON :: InputType -> Value # toEncoding :: InputType -> Encoding # toJSONList :: [InputType] -> Value # toEncodingList :: [InputType] -> Encoding #
FromJSON InputType Source #
Instance details Defined in Data.SirenJSON Methods parseJSON :: Value -> Parser InputType # parseJSONList :: Value -> Parser [InputType] #

Type Conversion

class FromEntity a where Source #

A type that can be converted from Entity.

Methods

fromEntity :: Entity -> a Source #

class ToEntity a where Source #

A type that can be converted to Entity.

Methods

toEntity :: a -> Entity Source #