Packages

  • package root
    Definition Classes
    root
  • package endpoints4s

    Definition Classes
    root
  • package algebra

    Algebra interfaces

    Algebra interfaces

    Definition Classes
    endpoints4s
  • trait JsonSchemas extends TuplesSchemas with PartialInvariantFunctorSyntax

    An algebra interface for describing algebraic data types.

    An algebra interface for describing algebraic data types. Such descriptions can be interpreted to produce a JSON schema of the data type, a JSON encoder, a JSON decoder, etc.

    A description contains the fields of a case class and their type, and the constructor names of a sealed trait.

    For instance, consider the following record type:

    case class User(name: String, age: Int)

    Its description is the following:

    object User {
      implicit val schema: JsonSchema[User] = (
        field[String]("name") zip
        field[Int]("age")
      ).xmap((User.apply _).tupled)(Function.unlift(User.unapply))
    }

    The description says that the record type has two fields, the first one has type String and is named “name”, and the second one has type Int and name “age”.

    To describe sum types you have to explicitly “tag” each alternative:

    sealed trait Shape
    case class Circle(radius: Double) extends Shape
    case class Rectangle(width: Double, height: Double) extends Shape
    
    object Shape {
      implicit val schema: JsonSchema[Shape] = {
        val circleSchema = field[Double]("radius").xmap(Circle)(Function.unlift(Circle.unapply))
        val rectangleSchema = (
          field[Double]("width") zip
          field[Double]("height")
        ).xmap((Rectangle.apply _).tupled)(Function.unlift(Rectangle.unapply))
        (circleSchema.tagged("Circle") orElse rectangleSchema.tagged("Rectangle"))
          .xmap[Shape] {
            case Left(circle) => circle
            case Right(rect)  => rect
          } {
            case c: Circle    => Left(c)
            case r: Rectangle => Right(r)
          }
      }
    }
    Definition Classes
    algebra
  • Enum
  • EnumOps
  • InvariantFunctorSyntax
  • JsonSchema
  • JsonSchemaDocumentationOps
  • JsonSchemaOps
  • PartialInvariantFunctorSyntax
  • Record
  • RecordOps
  • Tagged
  • TaggedOps

implicit final class TaggedOps[A] extends JsonSchemaDocumentationOps[A]

Source
JsonSchemas.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TaggedOps
  2. JsonSchemaDocumentationOps
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TaggedOps(taggedA: Tagged[A])

Type Members

  1. type Self = Tagged[A]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toany2stringadd[TaggedOps[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (TaggedOps[A], B)
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toArrowAssoc[TaggedOps[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (TaggedOps[A]) => Boolean, msg: => Any): TaggedOps[A]
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toEnsuring[TaggedOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (TaggedOps[A]) => Boolean): TaggedOps[A]
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toEnsuring[TaggedOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): TaggedOps[A]
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toEnsuring[TaggedOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): TaggedOps[A]
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toEnsuring[TaggedOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toStringFormat[TaggedOps[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def named(name: String): Tagged[A]

    Give a name to the schema

    Give a name to the schema

    • Encoder and decoder interpreters ignore the name,
    • Documentation interpreters use that name to refer to this schema.
    Note

    Names are used by documentation interpreters to construct references and the JSON schema specification requires these to be valid URI's. Consider using withTitle if you just want to override the heading displayed in documentation.

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def orElse[B](taggedB: Tagged[B]): Tagged[Either[A, B]]

    Define a schema that alternatively accepts taggedA or taggedB

    Define a schema that alternatively accepts taggedA or taggedB

    • Encoder interpreters forward to taggedA to encode a Left value or to taggedB to encode a Right value,
    • Decoder interpreters decode the type tag from the JSON object and then forward to taggedA or taggedB according to its value,
    • Documentation interpreters produce a oneOf schema listing the alternatives in taggedA and the alternatives in taggedB.
  23. def orElseMerge[B <: C, C >: A](taggedB: Tagged[B])(implicit cta: ClassTag[A], ctb: ClassTag[B]): Tagged[C]

    Define a schema that alternatively accepts taggedA or taggedB and merges the result

    Define a schema that alternatively accepts taggedA or taggedB and merges the result

    Similar to orElse but instead of returning a Tagged[Either[A, B]], it returns a Tagged[C], where C is a super type of both A and B.

    • Encoder interpreters forward to taggedA or taggedB based on the runtime type information of the value to encode,
    • Decoder interpreters decode the type tag from the JSON object, forward to taggedA or taggedB accordingly, and then widen the result type to C,
    • Documentation interpreters produce a oneOf schema listing the alternatives in taggedA and the alternatives in taggedB.
    Note

    Encoder interpreters rely on ClassTags to perform the runtime type test used for deciding whether to encode the C value as an A or a B. Consequently, types A and B must be distinct after erasure. Furthermore, the orElseMerge implementation requires the type B to not be a supertype of A. This should not happen in general. For instance, assuming three schemas, schema1, schema2, and schema3, for types having a common super-type, if you write schema1 orElseMerge schema2 orElseMerge schema3, then the right-hand side of orElseMerge is always a more specific type than its left-hand side. However, if you write schema1 orElseMerge (schema2 orElseMerge schema3) (note the parentheses), then the result of schema2 orElseMerge schema3 is a super-type of schema1. In such a case, the orElseMerge operation won’t work.

    See also

    isInstanceOf API documentation

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. def withDescription(description: String): Tagged[A]

    Include a description of what this schema represents

    Include a description of what this schema represents

    • Encoder and decoder interpreters ignore this description,
    • Documentation interpreters can show this description.
    description

    information about the values described by the schema

    Definition Classes
    TaggedOpsJsonSchemaDocumentationOps
  30. def withDiscriminator(name: String): Tagged[A]

    Override the name of the type discriminator field of this record.

  31. def withExample(example: A): Tagged[A]

    Include an example of value in this schema

    Include an example of value in this schema

    • Encoder and decoder interpreters ignore this value,
    • Documentation interpreters can show this example value.
    example

    Example value to attach to the schema

    Definition Classes
    TaggedOpsJsonSchemaDocumentationOps
  32. def withTitle(title: String): Tagged[A]

    Include a title for the schema

    Include a title for the schema

    • Encoder and decoder interpreters ignore the title,
    • Documentation interpreters can show this title.
    title

    short title to attach to the schema

    Definition Classes
    TaggedOpsJsonSchemaDocumentationOps

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (TaggedOps[A], B)
    Implicit
    This member is added by an implicit conversion from TaggedOps[A] toArrowAssoc[TaggedOps[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from JsonSchemaDocumentationOps[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromTaggedOps[A] to any2stringadd[TaggedOps[A]]

Inherited by implicit conversion StringFormat fromTaggedOps[A] to StringFormat[TaggedOps[A]]

Inherited by implicit conversion Ensuring fromTaggedOps[A] to Ensuring[TaggedOps[A]]

Inherited by implicit conversion ArrowAssoc fromTaggedOps[A] to ArrowAssoc[TaggedOps[A]]

Ungrouped