Servant.Hateoas

Documentation

data Collection (t :: Type)

Data-Kind representing Content-Types of HATEOAS collections.

Type parameter t is the Mime-Type suffix in application/vnd.collection+t.

Instances

Accept (Collection JSON)

Defined in Servant.Hateoas.ContentType.Collection

Methods

contentType :: Proxy (Collection JSON) -> MediaType

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

ToJSON a => MimeRender (Collection JSON) (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

mimeRender :: Proxy (Collection JSON) -> CollectionResource a -> ByteString

data CollectionResource a

Resource wrapper for Collection.

Instances

CollectingResource CollectionResource

Defined in Servant.Hateoas.ContentType.Collection

Methods

collect :: a -> CollectionResource a -> CollectionResource a

Resource CollectionResource

Defined in Servant.Hateoas.ContentType.Collection

Methods

addLink :: forall (a :: k). (String, Link) -> CollectionResource a -> CollectionResource a

(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 CollectionResource) => ToCollection (api :: Type) CollectionResource a

Defined in Servant.Hateoas.ContentType.Collection

Methods

toCollection :: Foldable f => f a -> CollectionResource a

toCollection' :: Foldable f => Proxy api -> Proxy CollectionResource -> f a -> CollectionResource a

ToJSON a => MimeRender (Collection JSON) (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

mimeRender :: Proxy (Collection JSON) -> CollectionResource a -> ByteString

ToJSON a => ToJSON (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

toJSON :: CollectionResource a -> Value

toEncoding :: CollectionResource a -> Encoding

toJSONList :: [CollectionResource a] -> Value

toEncodingList :: [CollectionResource a] -> Encoding

omitField :: CollectionResource a -> Bool

Generic (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Associated Types

type Rep (CollectionResource a) :: Type -> Type

Methods

from :: CollectionResource a -> Rep (CollectionResource a) x

to :: Rep (CollectionResource a) x -> CollectionResource a

Show a => Show (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

Methods

showsPrec :: Int -> CollectionResource a -> ShowS

show :: CollectionResource a -> String

showList :: [CollectionResource a] -> ShowS

type Rep (CollectionResource a)

Defined in Servant.Hateoas.ContentType.Collection

type Rep (CollectionResource a) = D1 ('MetaData "CollectionResource" "Servant.Hateoas.ContentType.Collection" "servant-hateoas-0.2.1-inplace" 'False) (C1 ('MetaCons "CollectionResource" 'PrefixI 'True) (S1 ('MetaSel ('Just "href") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Link)) :*: (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CollectionItem a]) :*: S1 ('MetaSel ('Just "links") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, Link)]))))

data HAL (t :: Type)

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

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

Instances

Accept (HAL JSON)

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)

Defined in Servant.Hateoas.ContentType.HAL

Methods

mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString

data HALResource a

Resource wrapper for HAL.

Instances

EmbeddingResource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

embed :: forall b (a :: k). ToJSON b => (String, b) -> HALResource a -> HALResource a

Resource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

addLink :: forall (a :: k). (String, Link) -> HALResource a -> HALResource a

(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

Defined in Servant.Hateoas.ContentType.HAL

Methods

toResource :: a -> HALResource a

toResource' :: Proxy api -> Proxy HALResource -> a -> HALResource a

ToJSON a => MimeRender (HAL JSON) (HALResource a)

Defined in Servant.Hateoas.ContentType.HAL

Methods

mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString

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.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)]))))

module Servant.Hateoas.Resource

module Servant.Hateoas.Some