json-schema-generic
API
Generated with
json-schema-generic/endpoints4s.generic/JsonSchemas

JsonSchemas

endpoints4s.generic.JsonSchemas
trait JsonSchemas extends 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))
 }

Attributes

Graph
Supertypes
trait JsonSchemas
class Object
trait Matchable
class Any
Show all

Members list

Type members

Classlikes

object GenericJsonSchema

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Inherited classlikes

final implicit class EnumOps[A](enumA: Enum[A]) extends JsonSchemaDocumentationOps[A]

Attributes

Inherited from:
JsonSchemas
Supertypes
class Object
trait Matchable
class Any
implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

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.

Attributes

Inherited from:
InvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
sealed trait JsonSchemaDocumentationOps[A]

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

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

Attributes

Inherited from:
JsonSchemas
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class EnumOps[A]
class JsonSchemaOps[A]
class RecordOps[A]
class TaggedOps[A]
final implicit class JsonSchemaOps[A](schemaA: JsonSchema[A]) extends JsonSchemaDocumentationOps[A]

Implicit methods for values of type JsonSchema

Implicit methods for values of type JsonSchema

Attributes

Inherited from:
JsonSchemas
Supertypes
class Object
trait Matchable
class Any
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])

Attributes

Inherited from:
PartialInvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
final implicit class RecordOps[A](recordA: Record[A]) extends JsonSchemaDocumentationOps[A]

Implicit methods for values of type Record

Implicit methods for values of type Record

Attributes

Inherited from:
JsonSchemas
Supertypes
class Object
trait Matchable
class Any
final implicit class TaggedOps[A](taggedA: Tagged[A]) extends JsonSchemaDocumentationOps[A]

Attributes

Inherited from:
JsonSchemas
Supertypes
class Object
trait Matchable
class Any

Inherited types

type Enum[A] <: JsonSchema[A]

A more specific type of JSON schema for enumerations, i.e. types that have a specific set of valid values

A more specific type of JSON schema for enumerations, i.e. types that have a specific set of valid values

Values of type Enum[A] can be constructed by the operations:

Attributes

Note

This type has implicit methods provided by the EnumOps class.

Inherited from:
JsonSchemas
type JsonSchema[A]

The JSON schema of a type A

The JSON schema of a type A

JSON schemas can be interpreted as encoders serializing values of type A into JSON, decoders de-serializing JSON documents into values of type A, or documentation rendering the underlying JSON schema.

The JsonSchemas trait provides implicit definitions of JsonSchema[A] for basic types (Int, Double, String, etc.), and operations such as field, optField, or enumeration, which construct more complex JSON schemas.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax, InvariantFunctorSyntax, and JsonSchemaOps classes.

Inherited from:
JsonSchemas
type Record[A] <: JsonSchema[A]

A more specific type of JSON schema for record types (case classes)

A more specific type of JSON schema for record types (case classes)

Values of type Record[A] can be constructed with the operations field and optField.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax, InvariantFunctorSyntax, and RecordOps classes.

Inherited from:
JsonSchemas
type Tagged[A] <: JsonSchema[A]

A more specific type of JSON schema for sum types (sealed traits)

A more specific type of JSON schema for sum types (sealed traits)

“Tagged” schemas include the name of the type A as an additional discriminator field. By default, the name of the discriminator field is defined by the operation defaultDiscriminatorName but it can be customized by calling the operation withDiscriminator.

Values of type Tagged[A] can be constructed by calling the operation tagged on a Record[A].

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax, InvariantFunctorSyntax, and TaggedOps classes.

Inherited from:
JsonSchemas

Value members

Concrete methods

def classTagToSchemaName(ct: ClassTag[_]): String

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.

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.

Attributes

inline def genericJsonSchema[A](using mirror: Of[A]): JsonSchema[A]

Derives a JsonSchema[A] for a type A.

Derives a JsonSchema[A] for a type A.

Attributes

See also

genericRecord for details on how schemas are derived for case classes

genericTagged for details on how schemas are derived for sealed traits

inline def genericRecord[A](using productOf: ProductOf[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,
  • has optional properties of the same name and type as each case class field with a default value,
  • 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, or defined by the @name, or @unnamed annotations.

Attributes

inline def genericTagged[A](using sumOf: SumOf[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,
  • if the sealed trait is annotated with @docs or @title, that information is added to the schema,
  • the resulting schema has a named, defined by the annotations @name or @unnamed, or by calling classTagToSchemaName with the trait’s ClassTag.

Attributes

Inherited methods

def bigdecimalWithConstraintsJsonSchema(props: NumericConstraints[BigDecimal]): JsonSchema[BigDecimal]

A JSON schema for type BigDecimal where certain properties, such as minimum, maximum, etc. are set.

A JSON schema for type BigDecimal where certain properties, such as minimum, maximum, etc. are set.

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
def doubleWithConstraintsJsonSchema(props: NumericConstraints[Double]): JsonSchema[Double]

A JSON schema for type Double where certain properties, such as minimum, maximum, etc. are set.

A JSON schema for type Double where certain properties, such as minimum, maximum, etc. are set.

Attributes

Inherited from:
JsonSchemas
def enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]

Promotes a schema to an enumeration.

Promotes a schema to an enumeration.

  • Decoder interpreters fail if the input value does not match the encoded values of any of the possible values,
  • Encoder interpreters never fail, even if the value is not contained in the set of possible values,
  • Documentation interpreters enrich the JSON schema with an enum property listing the possible values.

Attributes

Inherited from:
JsonSchemas
def field[A](name: String, documentation: Option[String])(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

  • Encoder interpreters produce a JSON object with one property of the given name,
  • Decoder interpreters fail if the JSON value is not a JSON object, or if it doesn’t contain the name property, or if the property has an invalid value (according to its tpe),
  • Documentation interpreters produce the JSON schema of a JSON object schema with one required property of the given name.

Attributes

Inherited from:
JsonSchemas
def floatWithConstraintsJsonSchema(props: NumericConstraints[Float]): JsonSchema[Float]

A JSON schema for type BigDecimal where certain properties, such as minimum, maximum, etc. are set.

A JSON schema for type BigDecimal where certain properties, such as minimum, maximum, etc. are set.

Attributes

Inherited from:
JsonSchemas
final def intEnumeration[A](values: Seq[A])(encode: A => Int)(implicit tpe: JsonSchema[Int]): Enum[A]

Convenient constructor for enumerations represented by int values.

Convenient constructor for enumerations represented by int values.

Attributes

Inherited from:
JsonSchemas
def intWithConstraintsJsonSchema(props: NumericConstraints[Int]): JsonSchema[Int]

A JSON schema for type Int where certain properties, such as minimum, maximum, etc. are set.

A JSON schema for type Int where certain properties, such as minimum, maximum, etc. are set.

Attributes

Inherited from:
JsonSchemas
def lazyRecord[A](name: String)(schema: => Record[A]): Record[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] =
   lazyRecord("Rec") {
     optField("next")(recursiveSchema)
   }.xmap(Recursive(_))(_.next)

Interpreters should return a JsonSchema value that does not evaluate the given schema unless it is effectively used.

Value parameters

name

A unique name identifying the schema

schema

The record JSON schema whose evaluation should be delayed

Attributes

Inherited from:
JsonSchemas
def lazySchema[A](name: String)(schema: => JsonSchema[A]): JsonSchema[A]

A lazy JSON schema that can references schemas currently being defined:

A lazy JSON schema that can references schemas currently being defined:

 case class Recursive(next: Option[Recursive])
 val recursiveSchema: JsonSchema[Recursive] = lazySchema("Rec")(
   optField("next")(recursiveSchema)
 ).xmap(Recursive)(_.next)

Interpreters should return a JsonSchema value that does not evaluate the given schema unless it is effectively used.

Value parameters

name

A unique name identifying the schema

schema

The record JSON schema whose evaluation should be delayed

Attributes

Inherited from:
JsonSchemas
def lazyTagged[A](name: String)(schema: => Tagged[A]): Tagged[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.

Value parameters

name

A unique name identifying the schema

schema

The tagged JSON schema whose evaluation should be delayed

Attributes

Inherited from:
JsonSchemas
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.

  • Decoder interpreters first try to decode incoming values with the given tpe schema, and then check that it is equal to the given value,
  • Encoder interpreters always produce the given value, encoded according to tpe,
  • Documentation interpreters enrich the JSON schema with a const property documenting its only possible value (or an enum property with a single item).

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))

Attributes

Inherited from:
JsonSchemas
def longWithConstraintsJsonSchema(props: NumericConstraints[Long]): JsonSchema[Long]

A JSON schema for type Long where certain properties, such as minimum, maximum, etc. are set.

A JSON schema for type Long where certain properties, such as minimum, maximum, etc. are set.

Attributes

Inherited from:
JsonSchemas
def namedEnum[A](schema: Enum[A], name: String): Enum[A]

Annotates the enumeration JSON schema with a name

Annotates the enumeration JSON schema with a name

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
def optField[A](name: String, documentation: Option[String])(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

  • Encoder interpreters can omit the field or emit a field with a null value,
  • Decoder interpreters successfully decode None if the field is absent or if it is present but has the value null. They fail if the field is present but contains an invalid value,
  • Documentation interpreters produce the JSON schema of a JSON object with an optional property of the given name.

Attributes

Inherited from:
JsonSchemas
def optFieldWithDefault[A : JsonSchema](name: String, defaultValue: A, docs: Option[String]): Record[A]

The JSON schema of a record with a single optional field with the given name

The JSON schema of a record with a single optional field with the given name

  • Decoders fallback to the defaultValue if the field is absent from the decoded JSON object. They fail if the field is present but has an invalid value,
  • Encoders must emit the field if it is not defaultValue, but can choose to omit it when it has the defaultValue
  • Documentation interpreters produce the JSON schema of a JSON object with an optional property of the given name.

Attributes

Inherited from:
JsonSchemas
def orElseMergeTagged[A : ClassTag, C >: A, B <: C : ClassTag](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[C]

The JSON schema of a coproduct that share the same parent type and thus can be widened to that parent type

The JSON schema of a coproduct that share the same parent type and thus can be widened to that parent type

Attributes

Inherited from:
JsonSchemas
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.

Attributes

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.

Inherited from:
JsonSchemas
def preciseField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[PreciseField[A]]

The JSON schema of a record with a single field name of type A with fine control over presence and null

The JSON schema of a record with a single field name of type A with fine control over presence and null

  • Encoder interpreters may produce a JSON object with one property of the given name, which can be set to the null value,
  • Decoder interpreters successfully decode Absent if the field is absent, Null if it is present but has the value null. They fail if the field is present but contains an invalid value,
  • Documentation interpreters produce the JSON schema of a JSON object with an optional property of the given name.

Attributes

Inherited from:
JsonSchemas
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.

Attributes

Inherited from:
JsonSchemas
def stringJsonSchema(format: Option[String]): JsonSchema[String]

A JSON schema for type String.

A JSON schema for type String.

Value parameters

format

An additional semantic information about the underlying format of the string

Attributes

See also
Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
def withDescriptionEnum[A](enumeration: Enum[A], description: String): Enum[A]

Add a description to the given enumeration JSON schema

Add a description to the given enumeration JSON schema

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
def withExampleEnum[A](enumeration: Enum[A], example: A): Enum[A]

Include an example value within the given enumeration JSON schema

Include an example value within the given enumeration JSON schema

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
def withTitleEnum[A](enumeration: Enum[A], title: String): Enum[A]

Add a title to the given enumeration JSON schema

Add a title to the given enumeration JSON schema

Attributes

Inherited from:
JsonSchemas
def withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]

Add a title to the given schema

Add a title to the given schema

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas
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

Attributes

Inherited from:
JsonSchemas

Deprecated and Inherited methods

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.

Value parameters

name

A unique name identifying the schema

schema

The record JSON schema whose evaluation should be delayed

Attributes

Deprecated
true
Inherited from:
JsonSchemas
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.

Value parameters

name

A unique name identifying the schema

schema

The tagged JSON schema whose evaluation should be delayed

Attributes

Deprecated
true
Inherited from:
JsonSchemas

Extensions

Extensions

extension [A <: Product](schema: JsonSchema[A])
inline def as[B](using mirror: ProductOf[B] { type MirroredElemTypes = A; }): JsonSchema[B]

Transforms a JsonSchema[A] into a JsonSchema[B], if A is the “generic” representation of B.

Transforms a JsonSchema[A] into a JsonSchema[B], if A is the “generic” representation of B.

Attributes

Implicits

Inherited implicits

final implicit def EnumOps[A](enumA: Enum[A]): EnumOps[A]

Attributes

Inherited from:
JsonSchemas
final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

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.

Attributes

Inherited from:
InvariantFunctorSyntax
final implicit def JsonSchemaOps[A](schemaA: JsonSchema[A]): JsonSchemaOps[A]

Implicit methods for values of type JsonSchema

Implicit methods for values of type JsonSchema

Attributes

Inherited from:
JsonSchemas
final implicit def PartialInvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: PartialInvariantFunctor[F]): PartialInvariantFunctorSyntax[A, F]

Attributes

Inherited from:
PartialInvariantFunctorSyntax
final implicit def RecordOps[A](recordA: Record[A]): RecordOps[A]

Implicit methods for values of type Record

Implicit methods for values of type Record

Attributes

Inherited from:
JsonSchemas
final implicit def TaggedOps[A](taggedA: Tagged[A]): TaggedOps[A]

Attributes

Inherited from:
JsonSchemas
implicit def arrayJsonSchema[C <: (Iterable), A](implicit jsonSchema: JsonSchema[A], factory: Factory[A, C[A]]): JsonSchema[C[A]]

A JSON schema for sequences

A JSON schema for sequences

Attributes

Inherited from:
JsonSchemas
implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]

A JSON schema for type BigDecimal

A JSON schema for type BigDecimal

Attributes

Inherited from:
JsonSchemas
implicit def booleanJsonSchema: JsonSchema[Boolean]

A JSON schema for type Boolean

A JSON schema for type Boolean

Attributes

Inherited from:
JsonSchemas
implicit def byteJsonSchema: JsonSchema[Byte]

A JSON schema for type Byte

A JSON schema for type Byte

Attributes

Inherited from:
JsonSchemas
final implicit def defaultStringJsonSchema: JsonSchema[String]

A JSON schema for type String

A JSON schema for type String

Attributes

Inherited from:
JsonSchemas
implicit def doubleJsonSchema: JsonSchema[Double]

A JSON schema for type Double

A JSON schema for type Double

Attributes

Inherited from:
JsonSchemas
implicit lazy val durationSchema: JsonSchema[Duration]

An ISO 8601 duration

An ISO 8601 duration

Attributes

See also
Inherited from:
JsonSchemas
implicit def emptyRecord: Record[Unit]

The JSON schema of a record with no fields

The JSON schema of a record with no fields

  • Encoder interpreters produce an empty JSON object,
  • Decoder interpreters fail if the JSON value is not a JSON object,
  • Documentation interpreters produce the JSON schema of a JSON object schema with no properties.

Attributes

Inherited from:
JsonSchemas
implicit def floatJsonSchema: JsonSchema[Float]

A JSON schema for type Float

A JSON schema for type Float

Attributes

Inherited from:
JsonSchemas
implicit lazy val instantJsonSchema: JsonSchema[Instant]

An ISO 8601 date-time in UTC

An ISO 8601 date-time in UTC

Attributes

See also
Inherited from:
JsonSchemas
implicit def intJsonSchema: JsonSchema[Int]

A JSON schema for type Int

A JSON schema for type Int

Attributes

Inherited from:
JsonSchemas
implicit def jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
JsonSchemas
implicit def longJsonSchema: JsonSchema[Long]

A JSON schema for type Long

A JSON schema for type Long

Attributes

Inherited from:
JsonSchemas
implicit 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

Attributes

Inherited from:
JsonSchemas
implicit lazy val offsetDateTimeSchema: JsonSchema[OffsetDateTime]

An ISO8601 date-time

An ISO8601 date-time

Attributes

See also
Inherited from:
JsonSchemas
implicit def recordPartialInvFunctor: PartialInvariantFunctor[Record]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
JsonSchemas
implicit def taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
JsonSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
implicit 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.

Attributes

Inherited from:
TuplesSchemas
final implicit lazy val uuidJsonSchema: JsonSchema[UUID]

A JSON schema for type UUID

A JSON schema for type UUID

Attributes

Inherited from:
JsonSchemas
Generated with