View Source JSONAPIPlug.Document (jsonapi_plug v2.0.0)

JSON:API Document

This module defines the structure of a JSON:API document and functions that handle serialization and deserialization. This also handles validation of JSON:API documents.

https://jsonapi.org/format/#document-structure

Summary

Types

data()

JSON:API Primary Data

errors()

JSON:API Errors

included()

JSON:API Included Resources

jsonapi()

JSON:API Object

links()

JSON:API Links

meta()

JSON:API Meta Information

payload()

t()

JSON:API Document

value()

Functions

deserialize(data)

Deserialize JSON:API Document

serialize(document)

Serialize a Document struct representing a JSON:API Document

Types

data()

@type data() ::
  JSONAPIPlug.Document.ResourceObject.t()
  | [JSONAPIPlug.Document.ResourceObject.t()]

JSON:API Primary Data

https://jsonapi.org/format/#document-top-level

errors()

@type errors() :: [JSONAPIPlug.Document.ErrorObject.t()]

JSON:API Errors

https://jsonapi.org/format/#errors

included()

@type included() :: [JSONAPIPlug.Document.ResourceObject.t()]

JSON:API Included Resources

https://jsonapi.org/format/#document-compound-documents

jsonapi()

@type jsonapi() :: JSONAPIPlug.Document.JSONAPIObject.t()

JSON:API Object

https://jsonapi.org/format/#document-jsonapi-object

links()

@type links() :: %{required(atom()) => JSONAPIPlug.Document.LinkObject.t()}

JSON:API Links

https://jsonapi.org/format/#document-links

meta()

@type meta() :: payload()

JSON:API Meta Information

https://jsonapi.org/format/#document-meta

payload()

@type payload() :: %{required(String.t()) => value()}

t()

@type t() :: %JSONAPIPlug.Document{
  data: JSONAPIPlug.Resource.t() | [JSONAPIPlug.Resource.t()] | nil,
  errors: errors() | nil,
  included: included() | nil,
  jsonapi: jsonapi() | nil,
  links: links() | nil,
  meta: meta() | nil
}

JSON:API Document

https://jsonapi.org/format/#document-structure

value()

@type value() ::
  String.t()
  | integer()
  | float()
  | [value()]
  | %{required(String.t()) => value()}
  | nil

Functions

deserialize(data)

@spec deserialize(payload()) :: t() | no_return()

Deserialize JSON:API Document

Takes a map representing a JSON:API Document as input, validates it and parses it into a t/0 struct.

serialize(document)

@spec serialize(t()) :: t() | no_return()

Serialize a Document struct representing a JSON:API Document

Takes a t/0 struct representing a JSON:API Document as input, validates it and returns the struct if valid.