HttpRestSchema

smithy4s.http.HttpRestSchema
See theHttpRestSchema companion object
sealed trait HttpRestSchema[A]

This construct indicates how a schema is split between http metadata (ie headers, path parameters, query parameters, status code) and body.

When the input or the output of an http operation has some elements that are coming from the body and some elements that are coming from the metadata, the schema is split in two schemas that each track the relevant subset.

The partial data resulting from the successful decoding of both subsets can be reconciled to recover the total data.

On the encoding side, the split allows to only encode the relevant subset of data as http headers, and the other subset as http body.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Empty[A]
class MetadataAndBody[A]
class OnlyBody[A]
class OnlyMetadata[A]
In this article