Servant.Hateoas.RelationLink

RelationLink

Type

data RelationLink

Link data-type for hypermedia-links in HATEOAS with potentially templated URIs.

Constructors

RelationLink

Fields

• _path :: Text
• _params :: [RelationParam]
• _templated :: Bool
• _method :: StdMethod
• _contentTypes :: [MediaType]
• _summary :: Maybe Text
• _description :: Maybe Text

Instances

ToJSON RelationLink

Defined in Servant.Hateoas.RelationLink

Methods

toJSON :: RelationLink -> Value

toEncoding :: RelationLink -> Encoding

toJSONList :: [RelationLink] -> Value

toEncodingList :: [RelationLink] -> Encoding

omitField :: RelationLink -> Bool

Show RelationLink

Defined in Servant.Hateoas.RelationLink

Methods

showsPrec :: Int -> RelationLink -> ShowS

show :: RelationLink -> String

showList :: [RelationLink] -> ShowS

Eq RelationLink

Defined in Servant.Hateoas.RelationLink

Methods

(==) :: RelationLink -> RelationLink -> Bool

(/=) :: RelationLink -> RelationLink -> Bool

data RelationParam

Parameter data-type for hypermedia-links in HATEOAS.

Constructors

RelationParam

Fields

• _name :: Text
• _required :: Bool

Instances

Show RelationParam

Defined in Servant.Hateoas.RelationLink

Methods

showsPrec :: Int -> RelationParam -> ShowS

show :: RelationParam -> String

showList :: [RelationParam] -> ShowS

Eq RelationParam

Defined in Servant.Hateoas.RelationLink

Methods

(==) :: RelationParam -> RelationParam -> Bool

(/=) :: RelationParam -> RelationParam -> Bool

Creation

fromURI :: [MediaType] -> StdMethod -> URI -> RelationLink

Creates a RelationLink from an URI.

Operations

mkPlaceHolder :: Text -> Text

Create a placeholder for a URI template parameter.

appendPath :: Text -> Text -> Text

Append a path to a URI.

Class

class HasRelationLink endpoint where

Class for creating a RelationLink to an API.

Methods

toRelationLink :: Proxy endpoint -> RelationLink

Instances

ReflectMethod m => HasRelationLink (NoContentVerb m :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (NoContentVerb m) -> RelationLink

(KnownSymbol sym, HasRelationLink b) => HasRelationLink (sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (sym :> b) -> RelationLink

HasRelationLink b => HasRelationLink (HttpVersion :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (HttpVersion :> b) -> RelationLink

HasRelationLink b => HasRelationLink (BasicAuth realm userData :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (BasicAuth realm userData :> b) -> RelationLink

(KnownSymbol sym, HasRelationLink b) => HasRelationLink (Capture' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Capture' mods sym a :> b) -> RelationLink

(KnownSymbol sym, HasRelationLink b) => HasRelationLink (CaptureAll sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (CaptureAll sym a :> b) -> RelationLink

(KnownSymbol sym, HasRelationLink b) => HasRelationLink (Description sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Description sym :> b) -> RelationLink

(KnownSymbol sym, HasRelationLink b) => HasRelationLink (Summary sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Summary sym :> b) -> RelationLink

HasRelationLink b => HasRelationLink (EmptyAPI :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (EmptyAPI :> b) -> RelationLink

HasRelationLink b => HasRelationLink (Fragment a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Fragment a :> b) -> RelationLink

HasRelationLink b => HasRelationLink (Header' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Header' mods sym a :> b) -> RelationLink

HasRelationLink b => HasRelationLink (IsSecure :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (IsSecure :> b) -> RelationLink

(HasRelationLink b, KnownSymbol sym) => HasRelationLink (QueryFlag sym :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryFlag sym :> b) -> RelationLink

(HasRelationLink b, KnownSymbol sym, SBoolI (FoldRequired mods)) => HasRelationLink (QueryParam' mods sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryParam' mods sym a :> b) -> RelationLink

(HasRelationLink b, KnownSymbol sym) => HasRelationLink (QueryParams sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryParams sym a :> b) -> RelationLink

(HasRelationLink b, KnownSymbol sym) => HasRelationLink (DeepQuery sym a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (DeepQuery sym a :> b) -> RelationLink

HasRelationLink b => HasRelationLink (QueryString :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (QueryString :> b) -> RelationLink

HasRelationLink b => HasRelationLink (RemoteHost :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (RemoteHost :> b) -> RelationLink

HasRelationLink b => HasRelationLink (ReqBody' mods cts a :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (ReqBody' mods cts a :> b) -> RelationLink

HasRelationLink b => HasRelationLink (WithNamedContext name subs sub :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (WithNamedContext name subs sub :> b) -> RelationLink

HasRelationLink b => HasRelationLink (WithResource res :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (WithResource res :> b) -> RelationLink

(HasRelationLink api, KnownSymbol sym) => HasRelationLink (Sym sym :> api :: Type)

Defined in Servant.Hateoas.Internal.Sym

Methods

toRelationLink :: Proxy (Sym sym :> api) -> RelationLink

HasRelationLink b => HasRelationLink (Vault :> b :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Vault :> b) -> RelationLink

(ReflectMethod m, AllMime cts) => HasRelationLink (UVerb m cts as :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (UVerb m cts as) -> RelationLink

(ReflectMethod m, AllMime cts) => HasRelationLink (Verb m s cts a :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Verb m s cts a) -> RelationLink

(ReflectMethod m, Accept ct) => HasRelationLink (Stream m s f ct a :: Type)

Defined in Servant.Hateoas.RelationLink

Methods

toRelationLink :: Proxy (Stream m s f ct a) -> RelationLink

Utility

ReflectStdMethod

reflectStdMethod :: ReflectMethod method => Proxy method -> StdMethod

Like reflectMethod but returns a StdMethod.