package hal
Describes Hypertext Application Language types and functions
- Alphabetic
- By Inheritance
- hal
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- type Embedded[T] = List[EmbeddedDef[T]]
- type EmbeddedDef[T] = (String, Either[ResourceObject[T, _], Seq[ResourceObject[T, _]]])
-
case class
LinkObject(href: String, name: Option[String] = None, title: Option[String] = None, templated: Option[Boolean] = None, type: Option[String] = None, deprecation: Option[String] = None, profile: Option[String] = None, hreflang: Option[String] = None) extends LinkObjectLike with Product with Serializable
Represents the default implementation of a Link Object which all aspects of the specification.
- type LinkObjectDef = (String, Either[LinkObject, Seq[LinkObject]])
-
trait
LinkObjectLike extends AnyRef
A Link Object represents a hyperlink from the containing resource to a URI.
- class LinkObjectSerializer extends CustomSerializer[LinkObject]
- type Links = List[LinkObjectDef]
-
case class
ResourceObject[T, E](links: Links = Nil, embedded: Embedded[E] = Nil, content: Option[T] = None) extends Product with Serializable
A Resource Object represents a resource.
A Resource Object represents a resource.
- links
contains links to other resources The "links" property is OPTIONAL. It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing "_links" object is a property.
- embedded
contains embedded resources The "embedded" property is OPTIONAL It is an object whose property names are link relation types (as defined by [RFC5988]) and values are either a Resource Object or an array of Resource Objects. Embedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI.
- content
represents an object that contains all other properties All properties of the content instance will be rendered as JSON, and represent the current state of the resource.
- class ResourceObjectBuilder[T, E] extends AnyRef
- class ResourceObjectSerializer extends CustomSerializer[ResourceObject[_, _]]
Value Members
- object LinkObject extends Serializable
- object LinkObjectSerializer
- object ResourceObjectSerializer