View Source JSONAPIPlug.Document.RelationshipObject (jsonapi_plug v2.0.0)

JSON:API Relationship Object

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

Summary

Types

links()
t()

Functions

deserialize(data)

Types

Link to this type

links()

View Source 
@type links() :: %{required(atom()) => JSONAPIPlug.Document.LinkObject.t()}
Link to this type

t()

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

Functions

Link to this function

deserialize(data)

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