gargantext-0.0.4.9.5: Search, map, share
Copyright(c) CNRS 2017-Present
LicenseAGPL + CECILL v3
Maintainerteam@gargantext.org
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Gargantext.API

Description

Main (RESTful) API of the instance Gargantext.

The Garg-API is typed to derive the documentation, the mock and tests.

This API is indeed typed in order to be able to derive both the server and the client sides.

The Garg-API-Monad enables: - Security (WIP) - Features (WIP) - Database connection (long term) - In Memory stack management (short term) - Logs (WIP)

Thanks to Yann Esposito for our discussions at the start and to Nicolas Pouillard (who mainly made it).

Synopsis

Documentation

data Mode Source #

Constructors

Dev 
Mock 
Prod 

Instances

Instances details
Read Mode Source # 
Instance details

Defined in Gargantext.API

Show Mode Source # 
Instance details

Defined in Gargantext.API

Methods

showsPrec :: Int -> Mode -> ShowS #

show :: Mode -> String #

showList :: [Mode] -> ShowS #

Generic Mode Source # 
Instance details

Defined in Gargantext.API

Associated Types

type Rep Mode :: Type -> Type #

Methods

from :: Mode -> Rep Mode x #

to :: Rep Mode x -> Mode #

type Rep Mode Source # 
Instance details

Defined in Gargantext.API

type Rep Mode = D1 ('MetaData "Mode" "Gargantext.API" "gargantext-0.0.4.9.5-IFz7nHafad4HfDNkPsR1x8" 'False) (C1 ('MetaCons "Dev" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Prod" 'PrefixI 'False) (U1 :: Type -> Type)))

startGargantext :: Mode -> PortNumber -> FilePath -> IO () Source #

startGargantext takes as parameters port number and Ini file.

makeApp :: (Typeable env, EnvC env) => env -> IO Application Source #

API Global

api :: Proxy API Source #

apiWithEkg :: Proxy (EkgAPI :<|> API) Source #

apiGarg :: Proxy GargAPI Source #