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

JSON:API Resource Object

https://jsonapi.org/format/#resource_object-resource-objects

Summary

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,
  relationships:
    %{required(String.t()) => [JSONAPIPlug.Document.RelationshipObject.t()]}
    | nil,
  type: type()
}
@type type() :: String.t()

Functions

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

serialize(resource_object)

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