org.zalando.jsonapi

model

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
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

    The representation of an attribute of the root object.

  2. type Attributes = Seq[Attribute]

    A collection of Attribute objects.

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

    The representation of an error object.

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

    An object containing references to the source of the error.

  5. type Errors = Seq[Error]

    A collection of Error objects.

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

    An array of resource objects.

  7. type JsonApi = Seq[JsonApiProperty]

    A collection of JsonApiProperty objects.

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

    An information about the implementation.

  9. type Links = Seq[Link]

    A collection of Link objects.

  10. type Meta = Map[String, Value]

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

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

    An object represents the relationship and describes underlying object.

  12. type Relationships = Map[String, Relationship]

    A collection of Relationship objects.

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

    A root, top-level object.

Value Members

  1. object JsonApiObject

    A companion object for json api implementation specific data.

  2. object Links

    Companion object for links.

  3. object RootObject extends Serializable

    A companion object for root level support types.

Inherited from AnyRef

Inherited from Any

Ungrouped