Versioning.Servant

Documentation

type VersionedJSON = VersionedJSONFrom V0

Drop-in replacement for the JSON data-type for seamless integration with servant.

data VersionedJSONFrom (v :: V)

Like VersionedJSON, with an additional type-parameter indicating the oldest version you want to be able to decode

Instances

Accept (VersionedJSONFrom from :: Type)

Defined in Versioning.Servant

Methods

contentType :: Proxy (VersionedJSONFrom from) -> MediaType

contentTypes :: Proxy (VersionedJSONFrom from) -> NonEmpty MediaType

(JsonDecodableToFrom from v a, ToJSON (a v)) => MimeRender (VersionedJSONFrom from :: Type) (a v)

Defined in Versioning.Servant

Methods

mimeRender :: Proxy (VersionedJSONFrom from) -> a v -> ByteString

JsonDecodableToFrom from v a => MimeUnrender (VersionedJSONFrom from :: Type) (a v)

Defined in Versioning.Servant

Methods

mimeUnrender :: Proxy (VersionedJSONFrom from) -> ByteString -> Either String (a v)

mimeUnrenderWithType :: Proxy (VersionedJSONFrom from) -> MediaType -> ByteString -> Either String (a v)