jsonapi

Type Members

final case class ApiRoot(apiRoot: Option[Path]) extends Product with Serializable
trait HasId extends AnyRef
trait Identifiable[A] extends AnyRef
trait Includes[+A] extends AnyRef
trait JsonApiFormat[T] extends JsonApiReader[T] with JsonApiWriter[T] with RootJsonFormat[T]

Annotations
@implicitNotFound( ... )
trait JsonApiReader[T] extends RootJsonReader[T]

Annotations
@implicitNotFound( ... )
final class JsonApiResourceMacro extends JsonApiCommon

Annotations
@compileTimeOnly( ... )
sealed trait JsonApiSorting extends AnyRef
trait JsonApiWriter[T] extends RootJsonWriter[T]

Annotations
@implicitNotFound( ... )
sealed trait JsonEmpty extends JsonOption[Nothing]
sealed abstract class JsonOption[+A] extends AnyRef
final case class JsonSome[+A](x: A) extends JsonOption[A] with Product with Serializable
final class Macros extends JsonApiWriters with JsonApiReaders

Annotations
@compileTimeOnly( ... )
trait Meta extends AnyRef
trait MetaProfile extends AnyRef
type NameMangler = (String) ⇒ String
abstract class PathTo[A] extends AnyRef
trait PolyIdentifiable[A <: Coproduct] extends Identifiable[A]
sealed trait PolyToMany[A <: Coproduct] extends AnyRef
sealed trait PolyToOne[A <: Coproduct] extends AnyRef
sealed trait RelatedResponse[A] extends AnyRef
trait ResourceType[A] extends AnyRef
sealed trait ToMany[A] extends AnyRef
sealed trait ToOne[A] extends AnyRef
final case class UntypedMeta(jsonBody: JsValue) extends Meta with Product with Serializable
final class jsonApiResource extends Annotation with StaticAnnotation

Annotations
@compileTimeOnly( ... )

Value Members

object ApiRoot extends Serializable
object HasId
object Identifiable
object Includes
object JsonAbsent extends JsonOption[Nothing] with JsonEmpty with Product with Serializable
object JsonApiResourceMacro
object JsonApiSorting
object JsonNull extends JsonOption[Nothing] with JsonEmpty with Product with Serializable
object JsonOption
object Link
object NameManglers
implicit object PathJsonFormat extends JsonFormat[Path]
object PathTo
object PolyIdentifiable
object PolyToMany
object PolyToOne
object RelatedResponse
object ResourceType
object ToMany
object ToOne
implicit def coproductJsonApiWriter0[L](implicit wl: JsonApiWriter[L]): JsonApiWriter[:+:[L, CNil]]
implicit def coproductJsonApiWriter1[L, R <: Coproduct](implicit wl: JsonApiWriter[L], wr: JsonApiWriter[R]): JsonApiWriter[:+:[L, R]]
macro def includes[A]: Includes[A]

Annotations
@compileTimeOnly( ... )
macro def jsonApiFormat[A]: JsonApiFormat[A]

Annotations
@compileTimeOnly( ... )
macro def jsonApiWriter[A]: JsonApiFormat[A]

Annotations
@compileTimeOnly( ... )
package macrosupport
def rawCollection[T](entities: Iterable[T])(implicit writer: JsonApiWriter[T], metaProfiles: Set[MetaProfile] = Set.empty, sorting: JsonApiSorting = JsonApiSorting.Unsorted): JsObject
def rawOne[T](entity: T)(implicit writer: JsonApiWriter[T], metaProfiles: Set[MetaProfile] = Set.empty, sorting: JsonApiSorting = JsonApiSorting.Unsorted): JsObject
def readCollection[T](json: JsObject, includes: Set[String])(implicit reader: JsonApiReader[T]): Iterable[T]
def readCollection[T](json: JsObject)(implicit reader: JsonApiReader[T]): Iterable[T]
def readOne[T](json: JsObject, includes: Set[String])(implicit reader: JsonApiReader[T]): T
def readOne[T](json: JsObject)(implicit reader: JsonApiReader[T]): T

package jsonapi

Type Members

final case class ApiRoot(apiRoot: Option[Path]) extends Product with Serializable

trait HasId extends AnyRef

trait Identifiable[A] extends AnyRef

trait Includes[+A] extends AnyRef

trait JsonApiFormat[T] extends JsonApiReader[T] with JsonApiWriter[T] with RootJsonFormat[T]

trait JsonApiReader[T] extends RootJsonReader[T]

final class JsonApiResourceMacro extends JsonApiCommon

sealed trait JsonApiSorting extends AnyRef

trait JsonApiWriter[T] extends RootJsonWriter[T]

sealed trait JsonEmpty extends JsonOption[Nothing]

sealed abstract class JsonOption[+A] extends AnyRef

final case class JsonSome[+A](x: A) extends JsonOption[A] with Product with Serializable

final class Macros extends JsonApiWriters with JsonApiReaders

trait Meta extends AnyRef

trait MetaProfile extends AnyRef

type NameMangler = (String) ⇒ String

abstract class PathTo[A] extends AnyRef

trait PolyIdentifiable[A <: Coproduct] extends Identifiable[A]

sealed trait PolyToMany[A <: Coproduct] extends AnyRef

sealed trait PolyToOne[A <: Coproduct] extends AnyRef

sealed trait RelatedResponse[A] extends AnyRef

trait ResourceType[A] extends AnyRef

sealed trait ToMany[A] extends AnyRef

sealed trait ToOne[A] extends AnyRef

final case class UntypedMeta(jsonBody: JsValue) extends Meta with Product with Serializable

final class jsonApiResource extends Annotation with StaticAnnotation

Value Members

object ApiRoot extends Serializable

object HasId

object Identifiable

object Includes

object JsonAbsent extends JsonOption[Nothing] with JsonEmpty with Product with Serializable

object JsonApiResourceMacro

object JsonApiSorting

object JsonNull extends JsonOption[Nothing] with JsonEmpty with Product with Serializable

object JsonOption

object Link

object NameManglers

implicit object PathJsonFormat extends JsonFormat[Path]

object PathTo

object PolyIdentifiable

object PolyToMany

object PolyToOne

object RelatedResponse

object ResourceType

object ToMany

object ToOne

implicit def coproductJsonApiWriter0[L](implicit wl: JsonApiWriter[L]): JsonApiWriter[:+:[L, CNil]]

implicit def coproductJsonApiWriter1[L, R <: Coproduct](implicit wl: JsonApiWriter[L], wr: JsonApiWriter[R]): JsonApiWriter[:+:[L, R]]

macro def includes[A]: Includes[A]

macro def jsonApiFormat[A]: JsonApiFormat[A]

macro def jsonApiWriter[A]: JsonApiFormat[A]

package macrosupport

def rawCollection[T](entities: Iterable[T])(implicit writer: JsonApiWriter[T], metaProfiles: Set[MetaProfile] = Set.empty, sorting: JsonApiSorting = JsonApiSorting.Unsorted): JsObject

def rawOne[T](entity: T)(implicit writer: JsonApiWriter[T], metaProfiles: Set[MetaProfile] = Set.empty, sorting: JsonApiSorting = JsonApiSorting.Unsorted): JsObject

def readCollection[T](json: JsObject, includes: Set[String])(implicit reader: JsonApiReader[T]): Iterable[T]

def readCollection[T](json: JsObject)(implicit reader: JsonApiReader[T]): Iterable[T]

def readOne[T](json: JsObject, includes: Set[String])(implicit reader: JsonApiReader[T]): T

def readOne[T](json: JsObject)(implicit reader: JsonApiReader[T]): T

Inherited from AnyRef

Inherited from Any

Ungrouped