JSONAPIPlug.Document.RelationshipObject (jsonapi_plug v2.0.1)

View Source

JSON:API Relationship Object

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

Summary

Types

links()
t()

Functions

deserialize(data)

Types

links()

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

t()

@type t() :: %JSONAPIPlug.Document.RelationshipObject{
  data:
    JSONAPIPlug.Document.ResourceIdentifierObject.t()
    | [JSONAPIPlug.Document.ResourceIdentifierObject.t()]
    | nil,
  links: links() | nil,
  meta: JSONAPIPlug.Document.meta() | nil
}

Functions

deserialize(data)

@spec deserialize(JSONAPIPlug.Document.payload()) :: t() | no_return()