Packages

  • package root
    Definition Classes
    root
  • package endpoints
    Definition Classes
    root
  • package algebra

    Definition Classes
    endpoints
  • 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
t

endpoints.algebra.JsonSchemas

JsonSchemaDocumentationOps

sealed trait JsonSchemaDocumentationOps[A] extends AnyRef

Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.

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

Type Members

  1. abstract type Self <: JsonSchema[A]

Abstract Value Members

  1. abstract def withDescription(description: String): Self

    Include a description of what this schema represents.

    Include a description of what this schema represents. Documentation interpreters can show this description. Encoder and decoder interpreters ignore this description.

    description

    information about the values described by the schema

  2. abstract def withExample(example: A): Self

    Include an example of value in this schema.

    Include an example of value in this schema. Documentation interpreters can show this example value. Encoder and decoder interpreters ignore this value.

    example

    Example value to attach to the schema

  3. abstract def withTitle(title: String): Self

    Include a title for the schema.

    Include a title for the schema. Documentation interpreters can show this title. Encoder and decoder interpreters ignore the title.

    title

    short title to attach to the schema

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (JsonSchemaDocumentationOps[A], B)
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toArrowAssoc[JsonSchemaDocumentationOps[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def ensuring(cond: (JsonSchemaDocumentationOps[A]) => Boolean, msg: => Any): JsonSchemaDocumentationOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toEnsuring[JsonSchemaDocumentationOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (JsonSchemaDocumentationOps[A]) => Boolean): JsonSchemaDocumentationOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toEnsuring[JsonSchemaDocumentationOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): JsonSchemaDocumentationOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toEnsuring[JsonSchemaDocumentationOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): JsonSchemaDocumentationOps[A]
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toEnsuring[JsonSchemaDocumentationOps[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toStringFormat[JsonSchemaDocumentationOps[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()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (JsonSchemaDocumentationOps[A], B)
    Implicit
    This member is added by an implicit conversion from JsonSchemaDocumentationOps[A] toArrowAssoc[JsonSchemaDocumentationOps[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 AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromJsonSchemaDocumentationOps[A] to StringFormat[JsonSchemaDocumentationOps[A]]

Inherited by implicit conversion Ensuring fromJsonSchemaDocumentationOps[A] to Ensuring[JsonSchemaDocumentationOps[A]]

Inherited by implicit conversion ArrowAssoc fromJsonSchemaDocumentationOps[A] to ArrowAssoc[JsonSchemaDocumentationOps[A]]

Ungrouped