JsonSchemas

trait JsonSchemas extends algebra.JsonSchemas

Enriches JsonSchemas with two kinds of operations:

genericJsonSchema[A] derives the JsonSchema of an algebraic data type A;
(field1 :×: field2 :×: …).as[A] builds a tuple of Records and maps it to a case class A

For instance, consider the following program that derives the JSON schema of a case class:

case class User(name: String, age: Int)
object User {
  implicit val schema: JsonSchema[User] = genericJsonSchema[User]
}

It is equivalent to the following:

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

Source: JsonSchemas.scala

Linear Supertypes

algebra.JsonSchemas, endpoints.PartialInvariantFunctorSyntax, endpoints.InvariantFunctorSyntax, TuplesSchemas, AnyRef, Any

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

JsonSchemas
JsonSchemas
PartialInvariantFunctorSyntax
InvariantFunctorSyntax
TuplesSchemas
AnyRef
Any

Implicitly

by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Type Members

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.
Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.
Definition Classes
InvariantFunctorSyntax
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
Definition Classes
PartialInvariantFunctorSyntax
implicit final class EnumOps[A] extends JsonSchemaDocumentationOps[A]
Definition Classes
JsonSchemas
sealed trait JsonSchemaDocumentationOps[A] extends AnyRef
Documentation related methods for annotating schemas.
Documentation related methods for annotating schemas. Encoder and decoder interpreters ignore this information.
Definition Classes
JsonSchemas
implicit final class JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
Implicit methods for values of type JsonSchema
Implicit methods for values of type JsonSchema
Definition Classes
JsonSchemas
implicit final class RecordOps[A] extends JsonSchemaDocumentationOps[A]
Implicit methods for values of type Record
Implicit methods for values of type Record
Definition Classes
JsonSchemas
implicit final class TaggedOps[A] extends JsonSchemaDocumentationOps[A]
Definition Classes
JsonSchemas
abstract type Enum[A] <: JsonSchema[A]
A JSON schema for enumerations, i.e.
A JSON schema for enumerations, i.e. types that have a restricted set of values.
Definition Classes
JsonSchemas
Note
This type has implicit methods provided by the EnumOps class.
trait GenericDescriptions extends AnyRef
Internal machinery for extracting a description of a type
trait GenericDiscriminatorNames extends AnyRef
Internal machinery for deriving the discriminator name of a type
trait GenericJsonSchema[A] extends AnyRef
Annotations
@implicitNotFound("Unable to derive an instance of JsonSchema[${A}].\n" +
"The type ${A} must be a sealed trait or a case class.\n" +
"If it is a sealed trait, make sure it is only extended by case classes and that a " +
"JsonSchema can be derived for each of these case classes (see hereafter).\n" +
"If it is a case class, make sure each field of the case class has an implicit JsonSchema.\n" +
"You can check that a JsonSchema is available for a type T by compiling the expression " +
"`implicitly[JsonSchema[T]]`.")
trait GenericJsonSchemaLowLowPriority extends AnyRef
trait GenericJsonSchemaLowPriority extends GenericJsonSchemaLowLowPriority
trait GenericSchemaNames extends AnyRef
Internal machinery for deriving the schema name of a type
trait GenericTitles extends AnyRef
Internal machinery for extracting a title of a type
abstract type JsonSchema[A]
The JSON schema of a type A
The JSON schema of a type A
Definition Classes
JsonSchemas
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax, InvariantFunctorSyntax, and JsonSchemaOps classes.
implicit final class JsonSchemaGenericOps[A] extends AnyRef
abstract type Record[A] <: JsonSchema[A]
The JSON schema of a record type (case class) A
The JSON schema of a record type (case class) A
Definition Classes
JsonSchemas
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax, InvariantFunctorSyntax, and RecordOps classes.
implicit final class RecordGenericOps[A] extends AnyRef
abstract type Tagged[A] <: JsonSchema[A]
A JSON schema containing the name of the type A.
A JSON schema containing the name of the type A. Tagged schemas are useful to describe sum types (sealed traits).
Definition Classes
JsonSchemas
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax, InvariantFunctorSyntax, and TaggedOps classes.

Abstract Value Members

implicit abstract def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], factory: Factory[A, C[A]]): JsonSchema[C[A]]
A JSON schema for sequences
A JSON schema for sequences
Definition Classes
JsonSchemas
implicit abstract def bigdecimalJsonSchema: JsonSchema[BigDecimal]
A JSON schema for type BigDecimal
A JSON schema for type BigDecimal
Definition Classes
JsonSchemas
implicit abstract def booleanJsonSchema: JsonSchema[Boolean]
A JSON schema for type Boolean
A JSON schema for type Boolean
Definition Classes
JsonSchemas
implicit abstract def byteJsonSchema: JsonSchema[Byte]
A JSON schema for type Byte
A JSON schema for type Byte
Definition Classes
JsonSchemas
abstract def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]
The JSON schema of a coproduct made of the given alternative tagged records
The JSON schema of a coproduct made of the given alternative tagged records
Definition Classes
JsonSchemas
implicit abstract def doubleJsonSchema: JsonSchema[Double]
A JSON schema for type Double
A JSON schema for type Double
Definition Classes
JsonSchemas
implicit abstract def emptyRecord: Record[Unit]
The JSON schema of a record with no fields
The JSON schema of a record with no fields
Definition Classes
JsonSchemas
abstract def enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]
Promotes a schema to an enumeration.
Promotes a schema to an enumeration. Decoding fails if the input string does not match the encoded values of any of the possible values. Encoding does never fail, even if the value is not contained in the set of possible values.
Definition Classes
JsonSchemas
abstract def field[A](name: String, documentation: Option[String] = None)(implicit tpe: JsonSchema[A]): Record[A]
The JSON schema of a record with a single field name of type A
The JSON schema of a record with a single field name of type A
Definition Classes
JsonSchemas
implicit abstract def floatJsonSchema: JsonSchema[Float]
A JSON schema for type Float
A JSON schema for type Float
Definition Classes
JsonSchemas
implicit abstract def intJsonSchema: JsonSchema[Int]
A JSON schema for type Int
A JSON schema for type Int
Definition Classes
JsonSchemas
implicit abstract def jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
JsonSchemas
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
abstract def lazyRecord[A](schema: => Record[A], name: String): JsonSchema[A]
Captures a lazy reference to a JSON schema currently being defined:
Captures a lazy reference to a JSON schema currently being defined:
```
case class Recursive(next: Option[Recursive])
val recursiveSchema: Record[Recursive] = (
  optField("next")(lazyRecord(recursiveSchema, "Rec"))
).xmap(Recursive)(_.next)
```
Interpreters should return a JsonSchema value that does not evaluate the given schema unless it is effectively used.
schema
The record JSON schema whose evaluation should be delayed
name
A unique name identifying the schema
Definition Classes
JsonSchemas
abstract def lazyTagged[A](schema: => Tagged[A], name: String): JsonSchema[A]
Captures a lazy reference to a JSON schema currently being defined.
Captures a lazy reference to a JSON schema currently being defined.
Interpreters should return a JsonSchema value that does not evaluate the given schema unless it is effectively used.
schema
The tagged JSON schema whose evaluation should be delayed
name
A unique name identifying the schema
Definition Classes
JsonSchemas
implicit abstract def longJsonSchema: JsonSchema[Long]
A JSON schema for type Long
A JSON schema for type Long
Definition Classes
JsonSchemas
implicit abstract def mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]
A JSON schema for maps with string keys
A JSON schema for maps with string keys
Definition Classes
JsonSchemas
abstract def namedEnum[A](schema: Enum[A], name: String): Enum[A]
Annotates the enum JSON schema with a name
Annotates the enum JSON schema with a name
Definition Classes
JsonSchemas
abstract def namedRecord[A](schema: Record[A], name: String): Record[A]
Annotates the record JSON schema with a name
Annotates the record JSON schema with a name
Definition Classes
JsonSchemas
abstract def namedTagged[A](schema: Tagged[A], name: String): Tagged[A]
Annotates the tagged JSON schema with a name
Annotates the tagged JSON schema with a name
Definition Classes
JsonSchemas
abstract def optField[A](name: String, documentation: Option[String] = None)(implicit tpe: JsonSchema[A]): Record[Option[A]]
The JSON schema of a record with a single optional field name of type A
The JSON schema of a record with a single optional field name of type A
Decoder interpreters successfully decode None if the field is absent or if it is present but has the value null. Decoder interpreters fail if the field is present but contains an invalid value. Encoder interpreters can omit the field or emit a field with a null value. Documentation interpreters must mark the field as optional.
Definition Classes
JsonSchemas
abstract def orFallbackToJsonSchema[A, B](schemaA: JsonSchema[A], 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.
Documentation interpreter produce a oneOf JSON schema. Encoder interpreters forward to either schemaA or schemaB. Decoder interpreters first try to decode with schemaA, and fallback to schemaB in case of failure.
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.
Definition Classes
JsonSchemas
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.
implicit abstract def recordPartialInvFunctor: PartialInvariantFunctor[Record]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
JsonSchemas
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
abstract def stringJsonSchema(format: Option[String]): JsonSchema[String]
A JSON schema for type String.
A JSON schema for type String.
format
An additional semantic information about the underlying format of the string
Definition Classes
JsonSchemas
See also
https://json-schema.org/understanding-json-schema/reference/string.html#format
implicit abstract def taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
JsonSchemas
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
abstract def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]
Tags a schema for type A with the given tag name
Tags a schema for type A with the given tag name
Definition Classes
JsonSchemas
implicit abstract def tuple10JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)]
A JSON schema for a tuple of 10 elements.
A JSON schema for a tuple of 10 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple11JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)]
A JSON schema for a tuple of 11 elements.
A JSON schema for a tuple of 11 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple12JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)]
A JSON schema for a tuple of 12 elements.
A JSON schema for a tuple of 12 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple13JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)]
A JSON schema for a tuple of 13 elements.
A JSON schema for a tuple of 13 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple14JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)]
A JSON schema for a tuple of 14 elements.
A JSON schema for a tuple of 14 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple15JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)]
A JSON schema for a tuple of 15 elements.
A JSON schema for a tuple of 15 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple16JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)]
A JSON schema for a tuple of 16 elements.
A JSON schema for a tuple of 16 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple17JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)]
A JSON schema for a tuple of 17 elements.
A JSON schema for a tuple of 17 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple18JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)]
A JSON schema for a tuple of 18 elements.
A JSON schema for a tuple of 18 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple19JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)]
A JSON schema for a tuple of 19 elements.
A JSON schema for a tuple of 19 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple20JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)]
A JSON schema for a tuple of 20 elements.
A JSON schema for a tuple of 20 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple21JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)]
A JSON schema for a tuple of 21 elements.
A JSON schema for a tuple of 21 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple22JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21], schema22: JsonSchema[T22]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]
A JSON schema for a tuple of 22 elements.
A JSON schema for a tuple of 22 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple2JsonSchema[T1, T2](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2]): JsonSchema[(T1, T2)]
A JSON schema for a tuple of 2 elements.
A JSON schema for a tuple of 2 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple3JsonSchema[T1, T2, T3](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3]): JsonSchema[(T1, T2, T3)]
A JSON schema for a tuple of 3 elements.
A JSON schema for a tuple of 3 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple4JsonSchema[T1, T2, T3, T4](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4]): JsonSchema[(T1, T2, T3, T4)]
A JSON schema for a tuple of 4 elements.
A JSON schema for a tuple of 4 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple5JsonSchema[T1, T2, T3, T4, T5](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5]): JsonSchema[(T1, T2, T3, T4, T5)]
A JSON schema for a tuple of 5 elements.
A JSON schema for a tuple of 5 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple6JsonSchema[T1, T2, T3, T4, T5, T6](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6]): JsonSchema[(T1, T2, T3, T4, T5, T6)]
A JSON schema for a tuple of 6 elements.
A JSON schema for a tuple of 6 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple7JsonSchema[T1, T2, T3, T4, T5, T6, T7](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7)]
A JSON schema for a tuple of 7 elements.
A JSON schema for a tuple of 7 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple8JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8)]
A JSON schema for a tuple of 8 elements.
A JSON schema for a tuple of 8 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
implicit abstract def tuple9JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]
A JSON schema for a tuple of 9 elements.
A JSON schema for a tuple of 9 elements.
Tuples are represented with JSON arrays, as documented in https://json-schema.org/understanding-json-schema/reference/array.html#tuple-validation.
Definition Classes
TuplesSchemas
abstract def withDescriptionEnum[A](enum: Enum[A], description: String): Enum[A]
Add a description to the given enum JSON schema
Add a description to the given enum JSON schema
Definition Classes
JsonSchemas
abstract def withDescriptionJsonSchema[A](schema: JsonSchema[A], description: String): JsonSchema[A]
Add a description to the given JSON schema
Add a description to the given JSON schema
Definition Classes
JsonSchemas
abstract def withDescriptionRecord[A](record: Record[A], description: String): Record[A]
Add a description to the given record JSON schema
Add a description to the given record JSON schema
Definition Classes
JsonSchemas
abstract def withDescriptionTagged[A](tagged: Tagged[A], description: String): Tagged[A]
Add a description to the given tagged JSON schema
Add a description to the given tagged JSON schema
Definition Classes
JsonSchemas
abstract def withDiscriminatorTagged[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]
Allows to specify name of discriminator field for sum type
Allows to specify name of discriminator field for sum type
Definition Classes
JsonSchemas
abstract def withExampleEnum[A](enum: Enum[A], example: A): Enum[A]
Include an example value within the given enum JSON schema
Include an example value within the given enum JSON schema
Definition Classes
JsonSchemas
abstract def withExampleJsonSchema[A](schema: JsonSchema[A], example: A): JsonSchema[A]
Include an example value within the given JSON schema
Include an example value within the given JSON schema
Definition Classes
JsonSchemas
abstract def withExampleRecord[A](record: Record[A], example: A): Record[A]
Include an example value within the given record JSON schema
Include an example value within the given record JSON schema
Definition Classes
JsonSchemas
abstract def withExampleTagged[A](tagged: Tagged[A], example: A): Tagged[A]
Include an example value within the given tagged JSON schema
Include an example value within the given tagged JSON schema
Definition Classes
JsonSchemas
abstract def withTitleEnum[A](enum: Enum[A], title: String): Enum[A]
Add a title to the given enum JSON schema
Add a title to the given enum JSON schema
Definition Classes
JsonSchemas
abstract def withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]
Add a title to the given schema
Add a title to the given schema
Definition Classes
JsonSchemas
abstract def withTitleRecord[A](record: Record[A], title: String): Record[A]
Add a title to the given record JSON schema
Add a title to the given record JSON schema
Definition Classes
JsonSchemas
abstract def withTitleTagged[A](tagged: Tagged[A], title: String): Tagged[A]
Add a title to the given tagged JSON schema
Add a title to the given tagged JSON schema
Definition Classes
JsonSchemas
abstract def zipRecords[A, B](recordA: Record[A], recordB: Record[B])(implicit t: Tupler[A, B]): Record[Out]
The JSON schema of a record merging the fields of the two given records
The JSON schema of a record merging the fields of the two given records
Definition Classes
JsonSchemas

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
def ->[B](y: B): (JsonSchemas, B)
Implicit
This member is added by an implicit conversion from JsonSchemas toArrowAssoc[JsonSchemas] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def classTagToSchemaName(ct: ClassTag[_]): String
Compute a schema name (used for documentation) based on a ClassTag.
Compute a schema name (used for documentation) based on a ClassTag. The provided implementation uses the fully qualified name of the class. This could result in non unique values and mess with documentation.
You can override this method to use a custom logic.
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def defaultDiscriminatorName: String
Default discriminator field name for sum types.
Default discriminator field name for sum types.
It defaults to "type", but you can override it twofold: - by overriding this field you can change default discriminator name algebra-wide - by using withDiscriminator you can specify discriminator field name for specific sum type
Definition Classes
JsonSchemas
implicit final def defaultStringJsonSchema: JsonSchema[String]
A JSON schema for type String
A JSON schema for type String
Definition Classes
JsonSchemas
def ensuring(cond: (JsonSchemas) => Boolean, msg: => Any): JsonSchemas
Implicit
This member is added by an implicit conversion from JsonSchemas toEnsuring[JsonSchemas] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (JsonSchemas) => Boolean): JsonSchemas
Implicit
This member is added by an implicit conversion from JsonSchemas toEnsuring[JsonSchemas] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): JsonSchemas
Implicit
This member is added by an implicit conversion from JsonSchemas toEnsuring[JsonSchemas] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): JsonSchemas
Implicit
This member is added by an implicit conversion from JsonSchemas toEnsuring[JsonSchemas] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from JsonSchemas toStringFormat[JsonSchemas] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def genericJsonSchema[A](implicit genJsonSchema: GenericJsonSchema[A]): JsonSchema[A]
Derives a JsonSchema[A] for a type A.
Derives a JsonSchema[A] for a type A.
In a sense, this operation asks shapeless to compute a type level description of a data type (based on HLists and Coproducts) and turns it into a term level description of the data type (based on the JsonSchemas algebra interface)
See also
genericRecord for details on how schemas are derived for case classes
genericTagged for details on how schemas are derived for sealed traits
def genericRecord[A](implicit genRecord: GenericJsonSchema.GenericRecord[A]): Record[A]
Derives a Record[A] schema for a case class A.
Derives a Record[A] schema for a case class A.
The resulting schema:
- describes a JSON object,
- has required properties of the same name and type as each case class field,
- has optional properties of the same name and type as each case class field of type Option[X] for some type X,
- includes the description possibly attached to each case class field via the @docs annotation,
- has a name, computed from a ClassTag[A] by the classTagToSchemaName operation.
def genericTagged[A](implicit genTagged: GenericJsonSchema.GenericTagged[A]): Tagged[A]
Derives a Tagged[A] schema for a sealed trait A.
Derives a Tagged[A] schema for a sealed trait A.
The resulting schema:
- is the alternative of the leaf case classes schemas,
- the field used for discriminating the alternatives is defined by the @discriminator annotation, if present on the sealed trait definition, or by the defaultDiscriminatorName method otherwise,
- each alternative is discriminated by the name (not qualified) of the case class.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def literal[A](value: A)(implicit tpe: JsonSchema[A]): JsonSchema[Unit]
A schema for a statically known value.
A schema for a statically known value.
Encoders always produce the given value, encoded according to tpe. Decoders first try to decode incoming values with the given tpe schema, and then check that it is equal to the given value.
This is useful to model schemas of objects containing extra fields that are absent from their Scala representation. For example, here is a schema for a GeoJSON point:
```
case class Point(lon: Double, lat: Double)
val pointSchema = (
  field("type")(literal("Point")) zip
  field[(Double, Double)]("coordinates")
).xmap(Point.tupled)(p => (p.lon, p.lat))
```
Definition Classes
JsonSchemas
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
implicit def shapelessGenericFromTuple[A, T, L <: HList](implicit tup: shapeless.ops.hlist.Tupler.Aux[L, T], genT: Aux[T, L], genA: Aux[A, L]): Aux[T, A]
final def stringEnumeration[A](values: Seq[A])(encode: (A) => String)(implicit tpe: JsonSchema[String]): Enum[A]
Convenient constructor for enumerations represented by string values.
Convenient constructor for enumerations represented by string values.
Definition Classes
JsonSchemas
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
implicit final lazy val uuidJsonSchema: JsonSchema[UUID]
A JSON schema for type UUID
A JSON schema for type UUID
Definition Classes
JsonSchemas
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
object GenericJsonSchema extends GenericJsonSchemaLowPriority with GenericDiscriminatorNames with GenericSchemaNames with GenericDescriptions with GenericTitles

Deprecated Value Members

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

Packages

JsonSchemas

trait JsonSchemas extends algebra.JsonSchemas

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from algebra.JsonSchemas

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from TuplesSchemas

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromJsonSchemas to StringFormat[JsonSchemas]

Inherited by implicit conversion Ensuring fromJsonSchemas to Ensuring[JsonSchemas]

Inherited by implicit conversion ArrowAssoc fromJsonSchemas to ArrowAssoc[JsonSchemas]

Types

Operations

Ungrouped

Packages

JsonSchemas

trait JsonSchemas extends algebra.JsonSchemas

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from algebra.JsonSchemas

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from TuplesSchemas

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromJsonSchemas to StringFormat[JsonSchemas]

Inherited by implicit conversion Ensuring fromJsonSchemas to Ensuring[JsonSchemas]

Inherited by implicit conversion ArrowAssoc fromJsonSchemas to ArrowAssoc[JsonSchemas]

Types

Operations

Ungrouped

JsonSchemas