| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.JSONApi.Document
Description
Contains representations of the top-level JSON-API document structure.
- data Document a
- data ResourceData a
- data ErrorDocument a = ErrorDocument {
- _error :: Error a
- _errorLinks :: Maybe Links
- _errorMeta :: Maybe Meta
- data Included
- mkDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Document a
- mkDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Document a
- singleton :: ResourcefulEntity a => a -> ResourceData a
- list :: ResourcefulEntity a => [a] -> ResourceData a
- mkCompoundDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Included -> Document a
- mkCompoundDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Included -> Document a
- mkIncludedResource :: ResourcefulEntity a => a -> Included
Documentation
The Document type represents the top-level JSON-API requirement.
data attribute - the resulting JSON may be either a singleton resource
or a list of resources. See Resource for the construction.
For more information see: http://jsonapi.org/format/#document-top-level
data ResourceData a Source #
The Resource type encapsulates the underlying Resource
Included in the top-level Document, the Resource may be either
a singleton resource or a list.
For more information see: http://jsonapi.org/format/#document-top-level
Instances
| Eq a => Eq (ResourceData a) Source # | |
| Show a => Show (ResourceData a) Source # | |
| Generic (ResourceData a) Source # | |
| ToJSON a => ToJSON (ResourceData a) Source # | |
| FromJSON a => FromJSON (ResourceData a) Source # | |
| type Rep (ResourceData a) Source # | |
data ErrorDocument a Source #
The ErrorDocument type represents the alternative form of the top-level
JSON-API requirement.
error attribute - a descriptive object encapsulating application-specific
error detail.
For more information see: http://jsonapi.org/format/#errors
Constructors
| ErrorDocument | |
Fields
| |
Instances
| Eq (ErrorDocument a) Source # | |
| Show (ErrorDocument a) Source # | |
| Generic (ErrorDocument a) Source # | |
| ToJSON a => ToJSON (ErrorDocument a) Source # | |
| FromJSON a => FromJSON (ErrorDocument a) Source # | |
| type Rep (ErrorDocument a) Source # | |
The Included type is an abstraction used to constrain the included
section of the Document to JSON serializable Resource objects while
enabling a heterogeneous list of Resource types.
No data constructors for this type are exported as we need to
constrain the Value to a heterogeneous list of Resource types.
See mkIncludedResource for creating Included types.
mkDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Document a Source #
Constructor function for the Document data type.
See mkCompoundDocument for constructing compound Document
including 'side-loaded' resources
mkDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Document a Source #
singleton :: ResourcefulEntity a => a -> ResourceData a Source #
list :: ResourcefulEntity a => [a] -> ResourceData a Source #
mkCompoundDocument :: ResourcefulEntity a => [a] -> Maybe Links -> Maybe Meta -> Included -> Document a Source #
Constructor function for the Document data type.
See mkIncludedResource for constructing the Included type.
Supports building compound documents http://jsonapi.org/format/#document-compound-documents
mkCompoundDocument' :: ResourceData a -> Maybe Links -> Maybe Meta -> Included -> Document a Source #
mkIncludedResource :: ResourcefulEntity a => a -> Included Source #
Constructor function for the Document data type.
Supports building compound documents http://jsonapi.org/format/#document-compound-documents