Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named

Documentation

data MkGargAPI sub mode #

Constructors

MkGargAPI
Fields mkGargAPI :: mode :- ("api" :> (Summary "API " :> NamedRoutes sub))

Instances details

Generic (MkGargAPI sub mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (MkGargAPI sub mode) :: Type -> Type # Methods from :: MkGargAPI sub mode -> Rep (MkGargAPI sub mode) x # to :: Rep (MkGargAPI sub mode) x -> MkGargAPI sub mode #
type Rep (MkGargAPI sub mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (MkGargAPI sub mode) = D1 ('MetaData "MkGargAPI" "Gargantext.API.Routes.Named" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "MkGargAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "mkGargAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("api" :> (Summary "API " :> NamedRoutes sub))))))

Constructors

GargAPIVersion
Fields gargAPIVersion :: mode :- ("v1.0" :> (Summary "Garg API Version " :> NamedRoutes sub))

Instances details

Generic (GargAPIVersion sub mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (GargAPIVersion sub mode) :: Type -> Type # Methods from :: GargAPIVersion sub mode -> Rep (GargAPIVersion sub mode) x # to :: Rep (GargAPIVersion sub mode) x -> GargAPIVersion sub mode #
type Rep (GargAPIVersion sub mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (GargAPIVersion sub mode) = D1 ('MetaData "GargAPIVersion" "Gargantext.API.Routes.Named" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GargAPIVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "gargAPIVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("v1.0" :> (Summary "Garg API Version " :> NamedRoutes sub))))))

data GargAPI' mode #

Constructors

Fields

Instances details

Generic (GargAPI' mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (GargAPI' mode) :: Type -> Type # Methods from :: GargAPI' mode -> Rep (GargAPI' mode) x # to :: Rep (GargAPI' mode) x -> GargAPI' mode #
type Rep (GargAPI' mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (GargAPI' mode) = D1 ('MetaData "GargAPI'" "Gargantext.API.Routes.Named" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GargAPI'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gargAuthAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes AuthAPI)) :: (S1 ('MetaSel ('Just "gargForgotPasswordAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("forgot-password" :> NamedRoutes ForgotPasswordAPI))) :: S1 ('MetaSel ('Just "gargForgotPasswordAsyncAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("async" :> ("forgot-password" :> NamedRoutes ForgotPasswordAsyncAPI)))))) :: (S1 ('MetaSel ('Just "gargVersionAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes GargVersion)) :: (S1 ('MetaSel ('Just "gargPrivateAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes GargPrivateAPI)) :*: S1 ('MetaSel ('Just "gargPublicAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("public" :> NamedRoutes GargPublicAPI)))))))

data AuthAPI mode #

Constructors

AuthAPI
Fields authEp :: mode :- ("auth" :> (Summary "AUTH API" :> (ReqBody '[JSON] AuthRequest :> Post '[JSON] AuthResponse)))

Instances details

Generic (AuthAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (AuthAPI mode) :: Type -> Type # Methods from :: AuthAPI mode -> Rep (AuthAPI mode) x # to :: Rep (AuthAPI mode) x -> AuthAPI mode #
type Rep (AuthAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (AuthAPI mode) = D1 ('MetaData "AuthAPI" "Gargantext.API.Routes.Named" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "AuthAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "authEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("auth" :> (Summary "AUTH API" :> (ReqBody '[JSON] AuthRequest :> Post '[JSON] AuthResponse)))))))

Constructors

ForgotPasswordAPI
Fields forgotPasswordPostEp :: mode :- (Summary "Forgot password POST API" :> (ReqBody '[JSON] ForgotPasswordRequest :> Post '[JSON] ForgotPasswordResponse)) forgotPasswordGetEp :: mode :- (Summary "Forgot password GET API" :> (QueryParam "uuid" Text :> Get '[JSON] ForgotPasswordGet))

Instances details

Generic (ForgotPasswordAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (ForgotPasswordAPI mode) :: Type -> Type # Methods from :: ForgotPasswordAPI mode -> Rep (ForgotPasswordAPI mode) x # to :: Rep (ForgotPasswordAPI mode) x -> ForgotPasswordAPI mode #
type Rep (ForgotPasswordAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (ForgotPasswordAPI mode) = D1 ('MetaData "ForgotPasswordAPI" "Gargantext.API.Routes.Named" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ForgotPasswordAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "forgotPasswordPostEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Forgot password POST API" :> (ReqBody '[JSON] ForgotPasswordRequest :> Post '[JSON] ForgotPasswordResponse)))) :*: S1 ('MetaSel ('Just "forgotPasswordGetEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Forgot password GET API" :> (QueryParam "uuid" Text :> Get '[JSON] ForgotPasswordGet))))))

Constructors

ForgotPasswordAsyncAPI
Fields forgotPasswordAsyncEp :: mode :- (Summary "Forgot password asnc" :> AsyncJobs JobLog '[JSON] ForgotPasswordAsyncParams JobLog)

Instances details

Generic (ForgotPasswordAsyncAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (ForgotPasswordAsyncAPI mode) :: Type -> Type # Methods from :: ForgotPasswordAsyncAPI mode -> Rep (ForgotPasswordAsyncAPI mode) x # to :: Rep (ForgotPasswordAsyncAPI mode) x -> ForgotPasswordAsyncAPI mode #
type Rep (ForgotPasswordAsyncAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (ForgotPasswordAsyncAPI mode)

Constructors

GargVersion
Fields gargVersionEp :: "version" :> (Summary "Backend version" :> Get '[JSON] Text)

Instances details

Generic (GargVersion mode) #
Instance details Defined in Gargantext.API.Routes.Named Associated Types type Rep (GargVersion mode) :: Type -> Type # Methods from :: GargVersion mode -> Rep (GargVersion mode) x # to :: Rep (GargVersion mode) x -> GargVersion mode #
type Rep (GargVersion mode) #
Instance details Defined in Gargantext.API.Routes.Named type Rep (GargVersion mode) = D1 ('MetaData "GargVersion" "Gargantext.API.Routes.Named" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GargVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "gargVersionEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ("version" :> (Summary "Backend version" :> Get '[JSON] Text)))))