Safe Haskell	Safe-Inferred
Language	GHC2021

Servant.Hateoas.ContentType.HAL

Synopsis

data HAL (t :: Type)
data HALResource a = HALResource {
- resource :: a
- links :: [(String, Link)]
- embedded :: [(String, SomeToJSON HALResource)]
}

Documentation

data HAL (t :: Type) Source #

Data-Kind 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 a => MimeRender (HAL JSON) (HALResource a) Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString #

data HALResource a Source #

Resource wrapper for HAL.

Constructors

HALResource
Fields resource :: a Wrapped resource links :: [(String, Link)] Pairs `(rel, link)` for relations embedded :: [(String, SomeToJSON HALResource)] Pairs `(rel, resource)` for embedded resources

Instances

Instances details

EmbeddingResource HALResource Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods embed :: forall b (a :: k). ToJSON b => (String, b) -> HALResource a -> HALResource a Source #
Resource HALResource Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods addLink :: forall (a :: k). (String, Link) -> HALResource a -> HALResource a Source #
(Related a, HasField (IdSelName a) a id, IsElem (GetOneApi a) api, HasLink (GetOneApi a), MkLink (GetOneApi a) Link ~ (id -> Link), BuildRels api (Relations a) a, Resource HALResource) => ToResource (api :: Type) HALResource a Source #
Instance details Defined in Servant.Hateoas.ContentType.HAL Methods toResource :: a -> HALResource a Source # toResource' :: Proxy api -> Proxy HALResource -> a -> HALResource a Source #
ToJSON 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, Related a, KnownSymbol (CollectionName 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.2.1-inplace" 'False) (C1 ('MetaCons "HALResource" 'PrefixI 'True) (S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :: (S1 ('MetaSel ('Just "links") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, Link)]) :: S1 ('MetaSel ('Just "embedded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, SomeToJSON HALResource)]))))