View Source JSONAPIPlug.Document.ResourceObject (jsonapi_plug v1.0.1)

JSON:API Resource Object

Link to this section Summary

Link to this section Types

@type id() :: String.t()
@type t() :: %JSONAPIPlug.Document.ResourceObject{
  attributes: %{required(String.t()) => JSONAPIPlug.Document.value()} | nil,
  id: id(),
  lid: id(),
  links: JSONAPIPlug.Document.links() | nil,
  meta: JSONAPIPlug.Document.meta() | nil,
    %{required(String.t()) => [JSONAPIPlug.Document.RelationshipObject.t()]}
    | nil,
  type: type()
@type type() :: String.t()

Link to this section Functions

@spec deserialize(JSONAPIPlug.Document.payload()) :: t() | no_return()
Link to this function


View Source
@spec serialize(t()) :: t()