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

JSON:API Error Object

https://jsonapi.org/format/#error-objects

Summary

Types

@type t() :: %JSONAPIPlug.Document.ErrorObject{
  code: String.t() | nil,
  detail: String.t() | nil,
  id: String.t() | nil,
  links: JSONAPIPlug.Document.links() | nil,
  meta: JSONAPIPlug.Document.meta() | nil,
  source: %{pointer: String.t()} | nil,
  status: String.t() | nil,
  title: String.t() | nil
}

Functions

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