Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Viz

Contents

Routes types
API types (appears in the routes)

Synopsis

data PhyloAPI mode = PhyloAPI {
- getPhyloEp :: mode :- (Summary "Phylo API" :> NamedRoutes GetPhylo)
- postPhyloEp :: mode :- NamedRoutes PostPhylo
}
newtype GetPhylo mode = GetPhylo {
- getPhyloDataEp :: mode :- (QueryParam "listId" ListId :> (QueryParam "level" Level :> (QueryParam "minSizeBranch" MinSizeBranch :> Get '[JSON] PhyloData)))
}
newtype PostPhylo mode = PostPhylo {
- postPhyloByListIdEp :: mode :- (QueryParam "listId" ListId :> Post '[JSON] NodeId)
}
data GraphAPI mode = GraphAPI {
- getGraphEp :: mode :- Get '[JSON] HyperdataGraphAPI
- getGraphAsyncEp :: mode :- ("async" :> NamedRoutes GraphAsyncAPI)
- cloneGraphEp :: mode :- ("clone" :> (ReqBody '[JSON] HyperdataGraphAPI :> Post '[JSON] NodeId))
- gexfEp :: mode :- ("gexf" :> Get '[XML] (Headers '[Header "Content-Disposition" Text] Graph))
- graphVersionsAPI :: mode :- ("versions" :> NamedRoutes GraphVersionsAPI)
}
newtype GraphAsyncAPI mode = GraphAsyncAPI {
- recomputeGraphEp :: mode :- (Summary "Recompute graph" :> ("recompute" :> AsyncJobsAPI JobLog () JobLog))
}
data GraphVersionsAPI mode = GraphVersionsAPI {
- getGraphVersionsEp :: mode :- (Summary "Graph versions" :> Get '[JSON] GraphVersions)
- recomputeGraphVersionEp :: mode :- (Summary "Recompute graph version" :> Post '[JSON] Graph)
}
data PhyloData = PhyloData {
- pd_corpusId :: NodeId
- pd_listId :: NodeId
- pd_data :: GraphData
- pd_config :: PhyloConfig
}
data GraphVersions = GraphVersions {
- gv_graph :: Maybe Int
- gv_repo :: Int
}

Routes types

data PhyloAPI mode #

Constructors

PhyloAPI
Fields getPhyloEp :: mode :- (Summary "Phylo API" :> NamedRoutes GetPhylo) postPhyloEp :: mode :- NamedRoutes PostPhylo

Instances

Instances details

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

newtype GetPhylo mode #

Constructors

GetPhylo
Fields getPhyloDataEp :: mode :- (QueryParam "listId" ListId :> (QueryParam "level" Level :> (QueryParam "minSizeBranch" MinSizeBranch :> Get '[JSON] PhyloData)))

Instances

Instances details

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

newtype PostPhylo mode #

Constructors

PostPhylo
Fields postPhyloByListIdEp :: mode :- (QueryParam "listId" ListId :> Post '[JSON] NodeId)

Instances

Instances details

Generic (PostPhylo mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz Associated Types type Rep (PostPhylo mode) :: Type -> Type # Methods from :: PostPhylo mode -> Rep (PostPhylo mode) x # to :: Rep (PostPhylo mode) x -> PostPhylo mode #
type Rep (PostPhylo mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz type Rep (PostPhylo mode) = D1 ('MetaData "PostPhylo" "Gargantext.API.Routes.Named.Viz" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "PostPhylo" 'PrefixI 'True) (S1 ('MetaSel ('Just "postPhyloByListIdEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (QueryParam "listId" ListId :> Post '[JSON] NodeId)))))

data GraphAPI mode #

Constructors

GraphAPI
Fields getGraphEp :: mode :- Get '[JSON] HyperdataGraphAPI getGraphAsyncEp :: mode :- ("async" :> NamedRoutes GraphAsyncAPI) cloneGraphEp :: mode :- ("clone" :> (ReqBody '[JSON] HyperdataGraphAPI :> Post '[JSON] NodeId)) gexfEp :: mode :- ("gexf" :> Get '[XML] (Headers '[Header "Content-Disposition" Text] Graph)) graphVersionsAPI :: mode :- ("versions" :> NamedRoutes GraphVersionsAPI)

Instances

Instances details

Generic (GraphAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz Associated Types type Rep (GraphAPI mode) :: Type -> Type # Methods from :: GraphAPI mode -> Rep (GraphAPI mode) x # to :: Rep (GraphAPI mode) x -> GraphAPI mode #
type Rep (GraphAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz type Rep (GraphAPI mode) = D1 ('MetaData "GraphAPI" "Gargantext.API.Routes.Named.Viz" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GraphAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "getGraphEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- Get '[JSON] HyperdataGraphAPI)) :: S1 ('MetaSel ('Just "getGraphAsyncEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("async" :> NamedRoutes GraphAsyncAPI)))) :: (S1 ('MetaSel ('Just "cloneGraphEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("clone" :> (ReqBody '[JSON] HyperdataGraphAPI :> Post '[JSON] NodeId)))) :: (S1 ('MetaSel ('Just "gexfEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("gexf" :> Get '[XML] (Headers '[Header "Content-Disposition" Text] Graph)))) :: S1 ('MetaSel ('Just "graphVersionsAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("versions" :> NamedRoutes GraphVersionsAPI)))))))

newtype GraphAsyncAPI mode #

Constructors

GraphAsyncAPI
Fields recomputeGraphEp :: mode :- (Summary "Recompute graph" :> ("recompute" :> AsyncJobsAPI JobLog () JobLog))

Instances

Instances details

Generic (GraphAsyncAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz Associated Types type Rep (GraphAsyncAPI mode) :: Type -> Type # Methods from :: GraphAsyncAPI mode -> Rep (GraphAsyncAPI mode) x # to :: Rep (GraphAsyncAPI mode) x -> GraphAsyncAPI mode #
type Rep (GraphAsyncAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz type Rep (GraphAsyncAPI mode) = D1 ('MetaData "GraphAsyncAPI" "Gargantext.API.Routes.Named.Viz" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "GraphAsyncAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "recomputeGraphEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary "Recompute graph" :> ("recompute" :> AsyncJobsAPI JobLog () JobLog))))))

data GraphVersionsAPI mode #

Constructors

GraphVersionsAPI
Fields getGraphVersionsEp :: mode :- (Summary "Graph versions" :> Get '[JSON] GraphVersions) recomputeGraphVersionEp :: mode :- (Summary "Recompute graph version" :> Post '[JSON] Graph)

Instances

Instances details

Generic (GraphVersionsAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz Associated Types type Rep (GraphVersionsAPI mode) :: Type -> Type # Methods from :: GraphVersionsAPI mode -> Rep (GraphVersionsAPI mode) x # to :: Rep (GraphVersionsAPI mode) x -> GraphVersionsAPI mode #
type Rep (GraphVersionsAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Viz type Rep (GraphVersionsAPI mode) = D1 ('MetaData "GraphVersionsAPI" "Gargantext.API.Routes.Named.Viz" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GraphVersionsAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "getGraphVersionsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Graph versions" :> Get '[JSON] GraphVersions))) :*: S1 ('MetaSel ('Just "recomputeGraphVersionEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- (Summary "Recompute graph version" :> Post '[JSON] Graph)))))

API types (appears in the routes)

data PhyloData #

Constructors

PhyloData
Fields pd_corpusId :: NodeId pd_listId :: NodeId pd_data :: GraphData pd_config :: PhyloConfig

Instances

Instances details

Arbitrary PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods arbitrary :: Gen PhyloData # shrink :: PhyloData -> [PhyloData] #
FromJSON PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods parseJSON :: Value -> Parser PhyloData # parseJSONList :: Value -> Parser [PhyloData] #
ToJSON PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods toJSON :: PhyloData -> Value # toEncoding :: PhyloData -> Encoding # toJSONList :: [PhyloData] -> Value # toEncodingList :: [PhyloData] -> Encoding #
Generic PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Associated Types type Rep PhyloData :: Type -> Type # Methods from :: PhyloData -> Rep PhyloData x # to :: Rep PhyloData x -> PhyloData #
Show PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods showsPrec :: Int -> PhyloData -> ShowS # show :: PhyloData -> String # showList :: [PhyloData] -> ShowS #
Eq PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods (==) :: PhyloData -> PhyloData -> Bool # (/=) :: PhyloData -> PhyloData -> Bool #
ToSchema PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods declareNamedSchema :: Proxy PhyloData -> Declare (Definitions Schema) NamedSchema #
type Rep PhyloData #
Instance details Defined in Gargantext.API.Routes.Named.Viz type Rep PhyloData = D1 ('MetaData "PhyloData" "Gargantext.API.Routes.Named.Viz" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "PhyloData" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pd_corpusId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeId) :: S1 ('MetaSel ('Just "pd_listId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeId)) :: (S1 ('MetaSel ('Just "pd_data") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GraphData) :*: S1 ('MetaSel ('Just "pd_config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PhyloConfig))))

data GraphVersions #

Constructors

GraphVersions
Fields gv_graph :: Maybe Int gv_repo :: Int

Instances

Instances details

FromJSON GraphVersions #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods parseJSON :: Value -> Parser GraphVersions # parseJSONList :: Value -> Parser [GraphVersions] #
ToJSON GraphVersions #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods toJSON :: GraphVersions -> Value # toEncoding :: GraphVersions -> Encoding # toJSONList :: [GraphVersions] -> Value # toEncodingList :: [GraphVersions] -> Encoding #
Generic GraphVersions #
Instance details Defined in Gargantext.API.Routes.Named.Viz Associated Types type Rep GraphVersions :: Type -> Type # Methods from :: GraphVersions -> Rep GraphVersions x # to :: Rep GraphVersions x -> GraphVersions #
Show GraphVersions #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods showsPrec :: Int -> GraphVersions -> ShowS # show :: GraphVersions -> String # showList :: [GraphVersions] -> ShowS #
ToSchema GraphVersions #
Instance details Defined in Gargantext.API.Routes.Named.Viz Methods declareNamedSchema :: Proxy GraphVersions -> Declare (Definitions Schema) NamedSchema #
type Rep GraphVersions #
Instance details Defined in Gargantext.API.Routes.Named.Viz type Rep GraphVersions = D1 ('MetaData "GraphVersions" "Gargantext.API.Routes.Named.Viz" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GraphVersions" 'PrefixI 'True) (S1 ('MetaSel ('Just "gv_graph") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "gv_repo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))