JsonApiClient v1.2.0 API Reference
Modules
A client library for interacting with REST APIs that comply with the JSON API spec described at http://jsonapi.org
JSON API Document Object http://jsonapi.org/format/#document-structure
JSON API JSON Error Object http://jsonapi.org/format/#errors
JSON API JSON Error Object http://jsonapi.org/format/#errors
JSON API JSON Error Object http://jsonapi.org/format/#errors
JSON API JSON API Object http://jsonapi.org/format/#document-jsonapi-object
JSON API JSON Links http://jsonapi.org/format/#document-links
The HTTP client middleware behaviour for the library
Adds default headers and options to the request
HTTP client JSON API doucment parser
Circuit Breaker middleware using fuse
Options
service_name -> :opts
- fuse options per service:opts
- fuse options when options are not configured per service (see fuse docs for reference)
HTTP client Middleware based on HTTPoison library
Stats Tracking Middleware
JSON API Relationships Object http://jsonapi.org/format/#document-resource-object-relationships
Describes a JSON API HTTP Request
JSON API Resource Object http://jsonapi.org/format/#document-resource-objects
JSON API Resource Identifier Object http://jsonapi.org/format/#document-resource-identifier-objects
A response from JSON API request
Exceptions
A Fatal Error during an API request