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 JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]

Implicit methods for values of type JsonSchema

Source
JsonSchemas.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonSchemaOps
  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 JsonSchemaOps(schemaA: JsonSchema[A])

Type Members

  1. type Self = JsonSchema[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 JsonSchemaOps[A] toany2stringadd[JsonSchemaOps[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JsonSchemaOps[A], B)
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toArrowAssoc[JsonSchemaOps[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: (JsonSchemaOps[A]) => Boolean, msg: => Any): JsonSchemaOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toEnsuring[JsonSchemaOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (JsonSchemaOps[A]) => Boolean): JsonSchemaOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toEnsuring[JsonSchemaOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): JsonSchemaOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toEnsuring[JsonSchemaOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): JsonSchemaOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toEnsuring[JsonSchemaOps[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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def orFallbackTo[B](schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]

    A schema that can be either schemaA or schemaB.

    A schema that can be either schemaA or schemaB.

    • Encoder interpreters forward to schemaA to encode a Left value or schemaB to encode a Right value,
    • Decoder interpreters first try to decode with schemaA, and fallback to schemaB in case of failure,
    • Documentation interpreter produce a oneOf JSON schema.

    The difference between this operation and the operation orElse on “tagged” schemas is that this operation does not rely on a discriminator field between the alternative schemas. As a consequence, decoding is slower than with “tagged” schemas and provides less precise error messages.

    schemaB

    fallback schema

    Note

    Be careful to use disjoint schemas for A and B (none must be a subtype of the other), otherwise, a value of type B might also be successfully decoded as a value of type A, and this could have surprising consequences.

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. def withDescription(description: String): JsonSchema[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
    JsonSchemaOpsJsonSchemaDocumentationOps
  27. def withExample(example: A): JsonSchema[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
    JsonSchemaOpsJsonSchemaDocumentationOps
  28. def withTitle(title: String): JsonSchema[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
    JsonSchemaOpsJsonSchemaDocumentationOps

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toStringFormat[JsonSchemaOps[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (JsonSchemaOps[A], B)
    Implicit
    This member is added by an implicit conversion from JsonSchemaOps[A] toArrowAssoc[JsonSchemaOps[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 fromJsonSchemaOps[A] to any2stringadd[JsonSchemaOps[A]]

Inherited by implicit conversion StringFormat fromJsonSchemaOps[A] to StringFormat[JsonSchemaOps[A]]

Inherited by implicit conversion Ensuring fromJsonSchemaOps[A] to Ensuring[JsonSchemaOps[A]]

Inherited by implicit conversion ArrowAssoc fromJsonSchemaOps[A] to ArrowAssoc[JsonSchemaOps[A]]

Ungrouped