Servant.Hateoas.ContentType.HAL

Documentation

data HAL (t :: Type)

Data-Kind representing Content-Types with Hypertext Application Language (HAL).

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

Instances

(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, HasResource (HAL t)) => ToResource (HAL t :: Type) (api :: Type) a

Defined in Servant.Hateoas.ContentType.HAL

Methods

toResource :: Proxy (HAL t) -> Proxy api -> a -> Resource (HAL t) a

Accept (HAL JSON)

Defined in Servant.Hateoas.ContentType.HAL

Methods

contentType :: Proxy (HAL JSON) -> MediaType

contentTypes :: Proxy (HAL JSON) -> NonEmpty MediaType

HasResource (HAL t :: Type)

Defined in Servant.Hateoas.ContentType.HAL

Associated Types

type Resource (HAL t) :: Type -> Type

type Resource (HAL t :: Type)

Defined in Servant.Hateoas.ContentType.HAL

type Resource (HAL t :: Type) = HALResource

data HALResource a

Resource wrapper for HAL.

Constructors

HALResource

Fields

• resource :: a
• links :: [(String, Link)]
• embedded :: [(String, SomeToJSON HALResource)]

Instances

ToJSON a => ToJSON (HALResource a)

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]

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)

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)

Defined in Servant.Hateoas.ContentType.HAL

type Rep (HALResource a) = D1 ('MetaData "HALResource" "Servant.Hateoas.ContentType.HAL" "servant-hateoas-0.1.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)]))))