Data.CollectionJSON

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

Full documentation for application/vnd.collection+json can be found at http://amundsen.com/media-types/collection/.

Core Data Types

data Collection

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

Constructors

Collection

Fields

• cVersion :: Text

  Currently, always "1.0".

• cHref :: URI

  Address used to retrieve the Collection and to add new elements.

• cLinks :: [Link]
• cItems :: [Item]
• cQueries :: [Query]
• cTemplate :: Maybe Template
• cError :: Maybe Error

Instances

Eq Collection

Methods

(==) :: Collection -> Collection -> Bool

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

Show Collection

Methods

showsPrec :: Int -> Collection -> ShowS

show :: Collection -> String

showList :: [Collection] -> ShowS

ToJSON Collection

Methods

toJSON :: Collection -> Value

toEncoding :: Collection -> Encoding

toJSONList :: [Collection] -> Value

toEncodingList :: [Collection] -> Encoding

FromJSON Collection

Methods

parseJSON :: Value -> Parser Collection

parseJSONList :: Value -> Parser [Collection]

data Link

A link to a related resource (not necessarily an application/vnd.collection+json resource).

Constructors

Link

Fields

• lHref :: URI

  Address of the resource.

• lRel :: Text

  Relation---the following contain suggested relation values:

  • IANA Link Relations
  • Microformat Existing Rel Values
  • RFC5988
• lName :: Maybe Text
• lRender :: Maybe Text
• lPrompt :: Maybe Text

Instances

Eq Link

Methods

(==) :: Link -> Link -> Bool

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

Show Link

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

ToJSON Link

Methods

toJSON :: Link -> Value

toEncoding :: Link -> Encoding

toJSONList :: [Link] -> Value

toEncodingList :: [Link] -> Encoding

FromJSON Link

Methods

parseJSON :: Value -> Parser Link

parseJSONList :: Value -> Parser [Link]

data Item

An element in the Collection

Constructors

Item

Fields

• iHref :: URI

  Address of the resource used to retrieve, modify, or delete the element.

• iData :: [Datum]
• iLinks :: [Link]

Instances

Eq Item

Methods

(==) :: Item -> Item -> Bool

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

Show Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

ToJSON Item

Methods

toJSON :: Item -> Value

toEncoding :: Item -> Encoding

toJSONList :: [Item] -> Value

toEncodingList :: [Item] -> Encoding

FromJSON Item

Methods

parseJSON :: Value -> Parser Item

parseJSONList :: Value -> Parser [Item]

data Query

A template for possible queries related to this Collection.

A query should correspond to an associated HTTP GET request.

The Query: > Query "http://example.com/search" "search" Nothing (Just Search:) [Datum "search" "" Nothing]

Corresponds with the following URI for an HTTP GET: > http://example.com/search?search={search_terms}

Constructors

Query

Fields

• qHref :: URI

  Address of reqeust's target.

• qRel :: Text

  Relation---the following contain suggested relation values:

  • IANA Link Relations
  • Microformat Existing Rel Values
  • RFC5988
• qName :: Maybe Text

  Identifier for this Query.

• qPrompt :: Maybe Text

  Suggested user prompt.

• qData :: [Datum]

  Query parameters for this Query.

Instances

Eq Query

Methods

(==) :: Query -> Query -> Bool

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

Show Query

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

ToJSON Query

Methods

toJSON :: Query -> Value

toEncoding :: Query -> Encoding

toJSONList :: [Query] -> Value

toEncodingList :: [Query] -> Encoding

FromJSON Query

Methods

parseJSON :: Value -> Parser Query

parseJSONList :: Value -> Parser [Query]

newtype Template

A fillable template for creation of a new object in the Collection.

Constructors

Template

Fields

• tData :: [Datum]

Instances

Eq Template

Methods

(==) :: Template -> Template -> Bool

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

Show Template

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

ToJSON Template

Methods

toJSON :: Template -> Value

toEncoding :: Template -> Encoding

toJSONList :: [Template] -> Value

toEncodingList :: [Template] -> Encoding

FromJSON Template

Methods

parseJSON :: Value -> Parser Template

parseJSONList :: Value -> Parser [Template]

data Error

Information about latest error that occured when responding to a request.

Constructors

Error

Fields

• eTitle :: Maybe Text
• eCode :: Maybe Text

  Unique identifier (e.g. session identifier, request tracker, etc).

• eMessage :: Maybe Text

Instances

Eq Error

Methods

(==) :: Error -> Error -> Bool

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

Show Error

Methods

showsPrec :: Int -> Error -> ShowS

show :: Error -> String

showList :: [Error] -> ShowS

ToJSON Error

Methods

toJSON :: Error -> Value

toEncoding :: Error -> Encoding

toJSONList :: [Error] -> Value

toEncodingList :: [Error] -> Encoding

FromJSON Error

Methods

parseJSON :: Value -> Parser Error

parseJSONList :: Value -> Parser [Error]

data Datum

Contents of a Collection Item.

Constructors

Datum

Fields

• dName :: Text

  Identifier for this Datum.

• dValue :: Maybe Text
• dPrompt :: Maybe Text

  Suggested user prompt.

Instances

Eq Datum

Methods

(==) :: Datum -> Datum -> Bool

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

Show Datum

Methods

showsPrec :: Int -> Datum -> ShowS

show :: Datum -> String

showList :: [Datum] -> ShowS

ToJSON Datum

Methods

toJSON :: Datum -> Value

toEncoding :: Datum -> Encoding

toJSONList :: [Datum] -> Value

toEncodingList :: [Datum] -> Encoding

FromJSON Datum

Methods

parseJSON :: Value -> Parser Datum

parseJSONList :: Value -> Parser [Datum]

Type Conversion

class FromCollection a where

A type that can be converted from Collection.

Minimal complete definition

fromCollection

Methods

fromCollection :: Collection -> a

class ToCollection a where

A type that can be converted to Collection.

Minimal complete definition

toCollection

Methods

toCollection :: a -> Collection