From 37ad3c66baa2df36594277022dcf68fa8d4fff26 Mon Sep 17 00:00:00 2001 From: Jakob Odersky Date: Thu, 2 Aug 2018 15:42:22 -0700 Subject: Rename default type field to '@type' --- shared/src/main/scala/DerivedFormats.scala | 2 +- shared/src/main/scala/annotations.scala | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) (limited to 'shared/src/main') diff --git a/shared/src/main/scala/DerivedFormats.scala b/shared/src/main/scala/DerivedFormats.scala index ed39f46..7c13314 100644 --- a/shared/src/main/scala/DerivedFormats.scala +++ b/shared/src/main/scala/DerivedFormats.scala @@ -68,7 +68,7 @@ trait DerivedFormats { self: BasicFormats => .collectFirst { case g: adt => g.typeFieldName } - .getOrElse("type") + .getOrElse("@type") new JsonFormat[T] { override def write(value: T): JsValue = ctx.dispatch(value) { sub => diff --git a/shared/src/main/scala/annotations.scala b/shared/src/main/scala/annotations.scala index 4437aeb..ad2a37f 100644 --- a/shared/src/main/scala/annotations.scala +++ b/shared/src/main/scala/annotations.scala @@ -7,16 +7,16 @@ import scala.annotation.StaticAnnotation * added to the final JSON objects. * * Note that by default all sealed traits are treated as ADTs, with a type - * field called `type`. This annotation enables overriding the name of that + * field called `@type`. This annotation enables overriding the name of that * field and is really only useful if a child itself has a field called `type` * that would otherwise result in a conflict. * * Example: * {{{ * // the JSON field "kind" will contain the actual type of the serialized child - * @adt("kind") sealed abstract class Keyword(`type`: String) - * case class If(`type`: String) extends Keyword(`type`) + * @adt("kind") sealed abstract class Keyword(`@type`: String) + * case class If(`@type`: String) extends Keyword(`@type`) * }}} * @param typeFieldName the name of the field to inject into a serialized JSON * object */ -final class adt(val typeFieldName: String = "type") extends StaticAnnotation +final class adt(val typeFieldName: String = "@type") extends StaticAnnotation -- cgit v1.2.3