JsonEntitiesFromSchemas

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

A query string parameter documentation description for type A

Extension methods for Endpoint.

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

Convenient methods for Paths.

Extension methods on QueryString.

Implicit methods for values of type Record

Extension methods for Request.

Extension methods for Response.

Callbacks indexed by URL pattern

Errors in a request built by a client

Error raised by the business logic of a server

Bad Request (400) response, with an entity of type ClientErrors.

Format of the response entity carrying the client errors.

Convert the ClientErrors type into the endpoints4s internal client error type

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

Helper method to perform DELETE request

Helper method to perform GET request

Convenient constructor for enumerations represented by int values.

Internal Server Error (500) response, with an entity of type ServerError.

Convert the endpoints4s internal client error type into the ClientErrors type

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

OK (200) Response with the given entity

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

Helper method to perform PATCH request

Helper method to perform POST request

Helper method to perform PUT request

Format of the response entity carrying the server error.

Convert the ServerError type into the endpoints4s internal server error type

Convenient constructor for enumerations represented by string values.

Convert the endpoints4s internal server error type into the ServerError type

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

Turns a Response[A] into a Response[Option[A]].

Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).

Response used by endpoints4s when decoding a request fails.

The provided implementation forwards to badRequest.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")

Response used by endpoints4s when the business logic of an endpoint fails.

The provided implementation forwards to internalServerError

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

Extension methods for Endpoint.

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

Implicit methods for values of type JsonSchema

Convenient methods for Paths.

Extension methods on QueryString.

Implicit methods for values of type Record

Extension methods for Request.

Extension methods for Response.

A JSON schema for type String

An ISO 8601 duration

An ISO 8601 date-time in UTC

An ISO8601 date-time