Package

org.zalando.jsonapi

model

Permalink

package model

The model package, containing partially covered Jsonapi specification.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. model
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Attribute(name: String, value: Value) extends Product with Serializable

    Permalink

    The representation of an attribute of the root object.

    The representation of an attribute of the root object.

    name

    the name of the attribute

    value

    the value of the attribute

  2. type Attributes = Seq[Attribute]

    Permalink

    A collection of Attribute objects.

  3. case class Error(id: Option[String] = None, links: Option[Links] = None, status: Option[String] = None, code: Option[String] = None, title: Option[String] = None, detail: Option[String] = None, source: Option[ErrorSource] = None, meta: Option[Meta] = None) extends Product with Serializable

    Permalink

    The representation of an error object.

    The representation of an error object.

    id

    an unique identifier of the error

    links

    the links of the error

    status

    the HTTP status code of the error

    code

    an application specific code of the error

    title

    a short human-readable description about the error

    detail

    a detailed human-readable description about the error

    source

    the source of the error

    meta

    the meta information about the error

  4. case class ErrorSource(pointer: Option[String] = None, parameter: Option[String] = None) extends Product with Serializable

    Permalink

    An object containing references to the source of the error.

    An object containing references to the source of the error.

    pointer

    the optional pointer based on RFC6901 standard

    parameter

    a optional string indicating which URI query parameter caused the error

  5. type Errors = Seq[Error]

    Permalink

    A collection of Error objects.

  6. case class Included(resourceObjects: ResourceObjects) extends Product with Serializable

    Permalink

    An array of resource objects.

    An array of resource objects.

    resourceObjects

    the array

  7. type JsonApi = Seq[JsonApiProperty]

    Permalink

    A collection of JsonApiProperty objects.

  8. case class JsonApiProperty(name: String, value: Value) extends Product with Serializable

    Permalink

    An information about the implementation.

    An information about the implementation.

    name

    the name of the json api implementation detail

    value

    the value of the json api implementation detail

  9. type Links = Seq[Link]

    Permalink

    A collection of Link objects.

  10. type Meta = Map[String, Value]

    Permalink

    The meta object as a map of string - json object value pairs

  11. case class Relationship(links: Option[Links] = None, data: Option[Data] = None) extends Product with Serializable

    Permalink

    An object represents the relationship and describes underlying object.

    An object represents the relationship and describes underlying object.

    links

    the links of underlying object

    data

    the data of underlying object

  12. type Relationships = Map[String, Relationship]

    Permalink

    A collection of Relationship objects.

  13. case class RootObject(data: Option[Data] = None, links: Option[Links] = None, errors: Option[Errors] = None, meta: Option[Meta] = None, included: Option[Included] = None, jsonApi: Option[JsonApi] = None) extends Product with Serializable

    Permalink

    A root, top-level object.

Value Members

  1. object JsonApiObject

    Permalink

    A companion object for json api implementation specific data.

  2. object Links

    Permalink

    Companion object for links.

  3. object RootObject extends Serializable

    Permalink

    A companion object for root level support types.

  4. package implicits

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped