| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Network.JSONApi.Document
Description
Entry-point module for this package.
Contains representations of the top-level JSON-API document structure.
- data Document a b c = Document {}
- data ErrorDocument a b = ErrorDocument {
- _error :: Error a
- _errorLinks :: Maybe Links
- _errorMeta :: Maybe (Meta b)
- data Error a = Error {}
- data ResourceData a b
- data Relationship
- data Resource a b = Resource {
- getIdentifier :: Identifier
- getResource :: a
- getLinks :: Maybe Links
- getMetaData :: Maybe (Meta b)
- getRelationships :: Maybe (Map Text Relationship)
- data Identifier = Identifier {}
- data Links
- data Meta a = Meta (Map Text a)
- toLinks :: [(Rel, URL)] -> Links
- mkRelationship :: Maybe Identifier -> Maybe Links -> Maybe Relationship
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
Instances
| (Eq a, Eq b, Eq c) => Eq (Document a b c) Source # | |
| (Show a, Show b, Show c) => Show (Document a b c) Source # | |
| Generic (Document a b c) Source # | |
| (ToJSON a, ToJSON b, ToJSON c) => ToJSON (Document a b c) Source # | |
| (FromJSON a, FromJSON b, FromJSON c) => FromJSON (Document a b c) Source # | |
| type Rep (Document a b c) Source # | |
data ErrorDocument a b 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 a, Eq b) => Eq (ErrorDocument a b) Source # | |
| (Show a, Show b) => Show (ErrorDocument a b) Source # | |
| Generic (ErrorDocument a b) Source # | |
| (ToJSON a, ToJSON b) => ToJSON (ErrorDocument a b) Source # | |
| (FromJSON a, FromJSON b) => FromJSON (ErrorDocument a b) Source # | |
| type Rep (ErrorDocument a b) Source # | |
Type for providing application-specific detail to unsuccessful API responses.
Specification: http://jsonapi.org/format/#error-objects
Constructors
| Error | |
data ResourceData a b 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
data Relationship Source #
A type representing the Relationship between 2 entities
A Relationship provides basic information for fetching further information about a related resource.
Specification: http://jsonapi.org/format/#document-resource-object-relationships
Instances
Type representing a JSON-API resource object.
A Resource supplies standardized data and metadata about a resource.
Specification: http://jsonapi.org/format/#document-resource-objects
Constructors
| Resource | |
Fields
| |
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 | |
Instances
Type representing a JSON-API link object.
Links are an abstraction around an underlying Map consisting of relevance identifiers as keys and URIs as values.
Example JSON:
"links": {
"self": "http://example.com/posts/1"
}
Specification: http://jsonapi.org/format/#document-links
Type representing a JSON-API meta object.
Meta is an abstraction around an underlying Map consisting of resource-specific metadata.
Example JSON:
"meta": {
"copyright": "Copyright 2015 Example Corp.",
"authors": [
"Andre Dawson",
"Kirby Puckett",
"Don Mattingly",
"Ozzie Guillen"
]
}
Specification: http://jsonapi.org/format/#document-meta
mkRelationship :: Maybe Identifier -> Maybe Links -> Maybe Relationship Source #
Constructor function for creating a Relationship record
A relationship must contain either an Identifier or a Links record