schemas

This object contains the options for how to encode coproduct JSON schemas.

The following Scala coproduct is the candidate example. Each encoding option includes the schema that it would generate for that example.

sealed trait Pet
case class Cat(name: String) extends Pet
case class Lizard(lovesRocks: Boolean) extends Pet

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

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

Implicit methods for values of type JsonSchema

Implicit methods for values of type Record

Override this method to customize the strategy used to encode the JSON schema of coproducts. By default, it uses CoproductEncoding.OneOf.

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

Convenient constructor for enumerations represented by int values.

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

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

Convenient constructor for enumerations represented by string values.

Convert the internal representation of a JSON schema into the public OpenAPI AST

The default schema for representing Invalid values is a JSON array containing error strings

The JSON codecs used to produce some parts of the documentation.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Implicit methods for values of type JsonSchema

Implicit methods for values of type Record

A JSON schema for type String

An ISO 8601 duration

An ISO 8601 date-time in UTC

An ISO8601 date-time

A JSON schema for type UUID