# `JSONAPIPlug.Document.RelationshipObject`
[🔗](https://github.com/lucacorti/jsonapi_plug/blob/main/lib/jsonapi_plug/document/relationship_object.ex#L1)

JSON:API Relationship Object

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

# `links`

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

# `t`

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

# `deserialize`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*