Safe Haskell	Safe-Inferred
Language	Haskell2010

Hercules.API.Auth

Synopsis

data AuthAPI auth f = AuthAPI {
- initiateGitHubLogin :: f :- ("api" :> ("auth" :> ("github" :> (QueryParam' '[Optional, Strict] "redirect" Text :> Get302 '[PlainText, JSON] '[]))))
- signOut :: f :- ("api" :> ("auth" :> ("sign-out" :> (auth :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie, Header "Set-Cookie" SetCookie] NoContent)))))
}

Documentation

Endpoints for authentication

Constructors

AuthAPI
Fields initiateGitHubLogin :: f :- ("api" :> ("auth" :> ("github" :> (QueryParam' '[Optional, Strict] "redirect" Text :> Get302 '[PlainText, JSON] '[])))) signOut :: f :- ("api" :> ("auth" :> ("sign-out" :> (auth :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie, Header "Set-Cookie" SetCookie] NoContent)))))

Instances details

Generic (AuthAPI auth f) Source #
Instance details Defined in Hercules.API.Auth Associated Types type Rep (AuthAPI auth f) :: Type -> Type # Methods from :: AuthAPI auth f -> Rep (AuthAPI auth f) x # to :: Rep (AuthAPI auth f) x -> AuthAPI auth f #
type Rep (AuthAPI auth f) Source #
Instance details Defined in Hercules.API.Auth type Rep (AuthAPI auth f) = D1 ('MetaData "AuthAPI" "Hercules.API.Auth" "hercules-ci-api-0.7.2.1-inplace" 'False) (C1 ('MetaCons "AuthAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "initiateGitHubLogin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("api" :> ("auth" :> ("github" :> (QueryParam' '[Optional, Strict] "redirect" Text :> Get302 '[PlainText, JSON] ('[] :: [Type]))))))) :*: S1 ('MetaSel ('Just "signOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("api" :> ("auth" :> ("sign-out" :> (auth :> Post '[JSON] (Headers '[Header "Set-Cookie" SetCookie, Header "Set-Cookie" SetCookie] NoContent)))))))))