Safe Haskell	Safe-Inferred
Language	GHC2021

Servant.Hateoas.ContentType.HAL

Contents

Content-Type
Resource-Type

Synopsis

data HAL (t :: Type)
data HALResource a = HALResource {
- resource :: a
- rels :: [(String, ResourceLink)]
- embedded :: [(String, SomeF HALResource ToJSON)]
}

Content-Type

data HAL (t :: Type) Source #

Type representing Content-Types of Hypertext Application Language (HAL).

Type parameter t is the mime type suffix in application/hal+t.

Instances

Instances details

Accept (HAL JSON) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods contentType :: Proxy (HAL JSON) -> MediaType # contentTypes :: Proxy (HAL JSON) -> NonEmpty MediaType #
ToJSON (HALResource a) => MimeRender (HAL JSON) (HALResource a) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString #
type MkResource (HAL t) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL type MkResource (HAL t) = HALResource

Resource-Type

data HALResource a Source #

HAL-resource representation.

Constructors

HALResource
Fields resource :: a Wrapped resource rels :: [(String, ResourceLink)] Pairs `(rel, link)` for hypermedia relations embedded :: [(String, SomeF HALResource ToJSON)] Pairs `(rel, resource)` for embedded resources

Instances

Instances details

Functor HALResource Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods fmap :: (a -> b) -> HALResource a -> HALResource b # (<$) :: a -> HALResource b -> HALResource a #
EmbeddingResource HALResource Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods embed :: ToJSON e => (String, HALResource e) -> HALResource a -> HALResource a Source #
Resource HALResource Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods wrap :: a -> HALResource a Source # addRel :: (String, ResourceLink) -> HALResource a -> HALResource a Source #
ToJSON (HALResource a) => MimeRender (HAL JSON) (HALResource a) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString #
ToJSON a => ToJSON (HALResource [a]) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods toJSON :: HALResource [a] -> Value # toEncoding :: HALResource [a] -> Encoding # toJSONList :: [HALResource [a]] -> Value # toEncodingList :: [HALResource [a]] -> Encoding # omitField :: HALResource [a] -> Bool #
ToJSON a => ToJSON (HALResource a) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods toJSON :: HALResource a -> Value # toEncoding :: HALResource a -> Encoding # toJSONList :: [HALResource a] -> Value # toEncodingList :: [HALResource a] -> Encoding # omitField :: HALResource a -> Bool #
Generic (HALResource a) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Associated Types type Rep (HALResource a) :: Type -> Type # Methods from :: HALResource a -> Rep (HALResource a) x # to :: Rep (HALResource a) x -> HALResource a #
type Rep (HALResource a) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL type Rep (HALResource a) = D1 ('MetaData "HALResource" "Servant.Hateoas.ContentType.HAL" "servant-hateoas-0.3.0-inplace" 'False) (C1 ('MetaCons "HALResource" 'PrefixI 'True) (S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :: (S1 ('MetaSel ('Just "rels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, ResourceLink)]) :: S1 ('MetaSel ('Just "embedded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, SomeF HALResource ToJSON)]))))