endpoints4s.generic

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

Defines the name of the discriminator field of a generic tagged schema.

Annotate a sealed trait definition with this annotation to define the name of its discriminator field.

Adds a description to a case class field, a case class, or a sealed trait.

Annotate a case class field, case class, or sealed trait with this annotation to set a description for the schema or the record field.

Defines the name of a generic schema.

Annotate a sealed trait or case class definition with this annotation to define its schema name. Setting the name of a schema explicitly means that you can control exactly what the URI of the JSON schema will be in the OpenAPI documentation.

Defines the title of a generic schema.

Annotate a sealed trait or case class definition with this annotation to define its schema title.

Specifies that a generic schema should not have a name.

Annotate a sealed trait or case class definition with this annotation to prevent the schema from being named. This is sometimes useful for forcing nested schemas to be inlined in OpenAPI documentation.