Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Node

Contents

Routes types
API types (might appear in the routes)

Synopsis

data NodeAPI mode a = NodeAPI {
- nodeNodeAPI :: mode :- PolicyChecked (NamedRoutes (NodeNodeAPI a))
- renameAPI :: mode :- ("rename" :> NamedRoutes RenameAPI)
- postNodeAPI :: mode :- NamedRoutes PostNodeAPI
- postNodeAsync :: mode :- NamedRoutes PostNodeAsync
- frameCalcUploadAPI :: mode :- NamedRoutes FrameCalcAPI
- putEp :: mode :- (ReqBody '[JSON] a :> Put '[JSON] Int)
- updateAPI :: mode :- ("update" :> NamedRoutes UpdateAPI)
- deleteEp :: mode :- Delete '[JSON] Int
- childrenAPI :: mode :- ("children" :> NamedRoutes (ChildrenAPI a))
- tableAPI :: mode :- ("table" :> NamedRoutes TableAPI)
- tableNgramsAPI :: mode :- ("ngrams" :> NamedRoutes TableNgramsAPI)
- catAPI :: mode :- ("category" :> NamedRoutes CatAPI)
- scoreAPI :: mode :- ("score" :> NamedRoutes ScoreAPI)
- searchAPI :: mode :- ("search" :> NamedRoutes (SearchAPI SearchResult))
- shareAPI :: mode :- ("share" :> NamedRoutes ShareNode)
- pairWithEp :: mode :- ("pairwith" :> NamedRoutes PairWith)
- pairsEp :: mode :- ("pairs" :> NamedRoutes Pairs)
- pairingEp :: mode :- ("pairing" :> NamedRoutes PairingAPI)
- scatterAPI :: mode :- ("metrics" :> NamedRoutes ScatterAPI)
- charAPI :: mode :- ("chart" :> NamedRoutes ChartAPI)
- pieAPI :: mode :- ("pie" :> NamedRoutes PieAPI)
- treeAPI :: mode :- ("tree" :> NamedRoutes NodeTreeAPI)
- phyloAPI :: mode :- ("phylo" :> NamedRoutes PhyloAPI)
- moveAPI :: mode :- ("move" :> NamedRoutes MoveAPI)
- unpublishEp :: mode :- ("unpublish" :> NamedRoutes Unpublish)
- fileAPI :: mode :- ("file" :> NamedRoutes FileAPI)
- fileAsyncAPI :: mode :- ("async" :> NamedRoutes FileAsyncAPI)
- dfwnAPI :: mode :- ("documents-from-write-nodes" :> NamedRoutes DocumentsFromWriteNodesAPI)
- documentUploadAPI :: mode :- NamedRoutes DocumentUploadAPI
}
newtype RenameAPI mode = RenameAPI {
- renameEp :: mode :- (Summary " Rename Node" :> (ReqBody '[JSON] RenameNode :> Put '[JSON] [Int]))
}
newtype PostNodeAPI mode = PostNodeAPI {
- postWithParentEp :: mode :- (Summary " PostNode Node with ParentId as {id}" :> (ReqBody '[JSON] PostNode :> Post '[JSON] [NodeId]))
}
newtype ChildrenAPI a mode = ChildrenAPI {
- summaryChildrenEp :: Summary " Summary children" :> (QueryParam "type" NodeType :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> Get '[JSON] (NodeTableResult a))))
}
newtype NodeNodeAPI a mode = NodeNodeAPI {
- getNodeEp :: mode :- Get '[JSON] (Node a)
}
newtype PostNodeAsync mode = PostNodeAsync {
- postNodeAsyncEp :: mode :- (Summary "Post Node" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] PostNode JobLog))
}
newtype CatAPI mode = CatAPI {
- categoriseEp :: mode :- (Summary " To Categorize NodeNodes: 0 for delete, 1/null neutral, 2 favorite" :> (ReqBody '[JSON] NodesToCategory :> Put '[JSON] [Int]))
}
newtype UpdateAPI mode = UpdateAPI {
- updateNodeEp :: mode :- (Summary " Update node according to NodeType params" :> AsyncJobs JobLog '[JSON] UpdateNodeParams JobLog)
}
newtype MoveAPI mode = MoveAPI {
- moveNodeEp :: mode :- (Summary "Move Node endpoint" :> (Capture "parent_id" ParentId :> Put '[JSON] [Int]))
}
newtype PairingAPI mode = PairingAPI {
- getPairingEp :: mode :- (Summary " Pairing API" :> (QueryParam "view" TabType :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> (QueryParam "order" OrderBy :> Get '[JSON] [FacetDoc])))))
}
newtype PairWith mode = PairWith {
- pairCorpusAnnuaireEp :: mode :- (Summary "Pair a Corpus with an Annuaire" :> ("annuaire" :> (Capture "annuaire_id" AnnuaireId :> (QueryParam "list_id" ListId :> Post '[JSON] [Int]))))
}
newtype Pairs mode = Pairs {
- pairsListEp :: mode :- (Summary "List of Pairs" :> Get '[JSON] [AnnuaireId])
}
data Roots mode = Roots {
- getRootsEp :: mode :- Get '[JSON] [Node HyperdataUser]
- putRootsEp :: mode :- Put '[JSON] Int
}
newtype NodesAPI mode = NodesAPI {
- deleteNodeEp :: mode :- Delete '[JSON] Int
}
data Charts
- = Sources
- | Authors
- | Institutes
- | Ngrams
- | All
data Granularity
- = NewNgrams
- | NewTexts
- | Both
data Method
- = Basic
- | Advanced
- | WithModel
data NodesToCategory = NodesToCategory {
- ntc_nodesId :: [NodeId]
- ntc_category :: Int
}
data PostNode = PostNode {
- pn_name :: Text
- pn_typename :: NodeType
}
newtype RenameNode = RenameNode {
- r_name :: Text
}
data UpdateNodeParams
- = UpdateNodeParamsList {
  - methodList :: !Method
  }
- | UpdateNodeParamsGraph {
  - methodGraphMetric :: !GraphMetric
  - methodGraphClustering :: !PartitionMethod
  - methodGraphBridgeness :: !BridgenessMethod
  - methodGraphEdgesStrength :: !Strength
  - methodGraphNodeType1 :: !NgramsType
  - methodGraphNodeType2 :: !NgramsType
  }
- | UpdateNodeParamsTexts {
  - methodTexts :: !Granularity
  }
- | UpdateNodeParamsBoard {
  - methodBoard :: !Charts
  }
- | LinkNodeReq {
  - nodeType :: !NodeType
  - id :: !NodeId
  }
- | UpdateNodePhylo {
  - config :: !PhyloSubConfigAPI
  }

Routes types

data NodeAPI mode a #

Node API Types management TODO-ACCESS : access by users No ownership check is needed if we strictly follow the capability model.

CanGetNode (Node, Children, TableApi, TableNgramsApiGet, PairingApi, ChartApi, SearchAPI) CanRenameNode (or part of CanEditNode?) CanCreateChildren (PostNodeApi) CanEditNode / CanPutNode TODO not implemented yet CanDeleteNode CanPatch (TableNgramsApi) CanFavorite CanMoveToTrash

Constructors

NodeAPI

Fields

nodeNodeAPI :: mode :- PolicyChecked (NamedRoutes (NodeNodeAPI a))
renameAPI :: mode :- ("rename" :> NamedRoutes RenameAPI)
postNodeAPI :: mode :- NamedRoutes PostNodeAPI
postNodeAsync :: mode :- NamedRoutes PostNodeAsync
frameCalcUploadAPI :: mode :- NamedRoutes FrameCalcAPI
putEp :: mode :- (ReqBody '[JSON] a :> Put '[JSON] Int)
updateAPI :: mode :- ("update" :> NamedRoutes UpdateAPI)
deleteEp :: mode :- Delete '[JSON] Int
childrenAPI :: mode :- ("children" :> NamedRoutes (ChildrenAPI a))
tableAPI :: mode :- ("table" :> NamedRoutes TableAPI)
tableNgramsAPI :: mode :- ("ngrams" :> NamedRoutes TableNgramsAPI)
catAPI :: mode :- ("category" :> NamedRoutes CatAPI)
scoreAPI :: mode :- ("score" :> NamedRoutes ScoreAPI)
searchAPI :: mode :- ("search" :> NamedRoutes (SearchAPI SearchResult))
shareAPI :: mode :- ("share" :> NamedRoutes ShareNode)
pairWithEp :: mode :- ("pairwith" :> NamedRoutes PairWith)
pairsEp :: mode :- ("pairs" :> NamedRoutes Pairs)
pairingEp :: mode :- ("pairing" :> NamedRoutes PairingAPI)
scatterAPI :: mode :- ("metrics" :> NamedRoutes ScatterAPI)
charAPI :: mode :- ("chart" :> NamedRoutes ChartAPI)
pieAPI :: mode :- ("pie" :> NamedRoutes PieAPI)
treeAPI :: mode :- ("tree" :> NamedRoutes NodeTreeAPI)
phyloAPI :: mode :- ("phylo" :> NamedRoutes PhyloAPI)
moveAPI :: mode :- ("move" :> NamedRoutes MoveAPI)
unpublishEp :: mode :- ("unpublish" :> NamedRoutes Unpublish)
fileAPI :: mode :- ("file" :> NamedRoutes FileAPI)
fileAsyncAPI :: mode :- ("async" :> NamedRoutes FileAsyncAPI)
dfwnAPI :: mode :- ("documents-from-write-nodes" :> NamedRoutes DocumentsFromWriteNodesAPI)
documentUploadAPI :: mode :- NamedRoutes DocumentUploadAPI

Instances

Instances details

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

newtype RenameAPI mode #

Constructors

RenameAPI
Fields renameEp :: mode :- (Summary " Rename Node" :> (ReqBody '[JSON] RenameNode :> Put '[JSON] [Int]))

Instances

Instances details

Generic (RenameAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (RenameAPI mode) :: Type -> Type # Methods from :: RenameAPI mode -> Rep (RenameAPI mode) x # to :: Rep (RenameAPI mode) x -> RenameAPI mode #
type Rep (RenameAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (RenameAPI mode) = D1 ('MetaData "RenameAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "RenameAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "renameEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " Rename Node" :> (ReqBody '[JSON] RenameNode :> Put '[JSON] [Int]))))))

newtype PostNodeAPI mode #

Constructors

PostNodeAPI
Fields postWithParentEp :: mode :- (Summary " PostNode Node with ParentId as {id}" :> (ReqBody '[JSON] PostNode :> Post '[JSON] [NodeId]))

Instances

Instances details

Generic (PostNodeAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (PostNodeAPI mode) :: Type -> Type # Methods from :: PostNodeAPI mode -> Rep (PostNodeAPI mode) x # to :: Rep (PostNodeAPI mode) x -> PostNodeAPI mode #
type Rep (PostNodeAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (PostNodeAPI mode) = D1 ('MetaData "PostNodeAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "PostNodeAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "postWithParentEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " PostNode Node with ParentId as {id}" :> (ReqBody '[JSON] PostNode :> Post '[JSON] [NodeId]))))))

newtype ChildrenAPI a mode #

Constructors

ChildrenAPI
Fields summaryChildrenEp :: Summary " Summary children" :> (QueryParam "type" NodeType :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> Get '[JSON] (NodeTableResult a))))

Instances

Instances details

Generic (ChildrenAPI a mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (ChildrenAPI a mode) :: Type -> Type # Methods from :: ChildrenAPI a mode -> Rep (ChildrenAPI a mode) x # to :: Rep (ChildrenAPI a mode) x -> ChildrenAPI a mode #
type Rep (ChildrenAPI a mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (ChildrenAPI a mode) = D1 ('MetaData "ChildrenAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "ChildrenAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "summaryChildrenEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Summary " Summary children" :> (QueryParam "type" NodeType :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> Get '[JSON] (NodeTableResult a))))))))

newtype NodeNodeAPI a mode #

Constructors

NodeNodeAPI
Fields getNodeEp :: mode :- Get '[JSON] (Node a)

Instances

Instances details

Generic (NodeNodeAPI a mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (NodeNodeAPI a mode) :: Type -> Type # Methods from :: NodeNodeAPI a mode -> Rep (NodeNodeAPI a mode) x # to :: Rep (NodeNodeAPI a mode) x -> NodeNodeAPI a mode #
type Rep (NodeNodeAPI a mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (NodeNodeAPI a mode) = D1 ('MetaData "NodeNodeAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "NodeNodeAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "getNodeEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- Get '[JSON] (Node a)))))

newtype PostNodeAsync mode #

Constructors

PostNodeAsync
Fields postNodeAsyncEp :: mode :- (Summary "Post Node" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] PostNode JobLog))

Instances

Instances details

Generic (PostNodeAsync mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (PostNodeAsync mode) :: Type -> Type # Methods from :: PostNodeAsync mode -> Rep (PostNodeAsync mode) x # to :: Rep (PostNodeAsync mode) x -> PostNodeAsync mode #
type Rep (PostNodeAsync mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (PostNodeAsync mode) = D1 ('MetaData "PostNodeAsync" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "PostNodeAsync" 'PrefixI 'True) (S1 ('MetaSel ('Just "postNodeAsyncEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary "Post Node" :> ("async" :> AsyncJobs JobLog '[FormUrlEncoded] PostNode JobLog))))))

newtype CatAPI mode #

Constructors

CatAPI
Fields categoriseEp :: mode :- (Summary " To Categorize NodeNodes: 0 for delete, 1/null neutral, 2 favorite" :> (ReqBody '[JSON] NodesToCategory :> Put '[JSON] [Int]))

Instances

Instances details

Generic (CatAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (CatAPI mode) :: Type -> Type # Methods from :: CatAPI mode -> Rep (CatAPI mode) x # to :: Rep (CatAPI mode) x -> CatAPI mode #
type Rep (CatAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (CatAPI mode) = D1 ('MetaData "CatAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "CatAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "categoriseEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " To Categorize NodeNodes: 0 for delete, 1/null neutral, 2 favorite" :> (ReqBody '[JSON] NodesToCategory :> Put '[JSON] [Int]))))))

newtype UpdateAPI mode #

Constructors

UpdateAPI
Fields updateNodeEp :: mode :- (Summary " Update node according to NodeType params" :> AsyncJobs JobLog '[JSON] UpdateNodeParams JobLog)

Instances

Instances details

Generic (UpdateAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (UpdateAPI mode) :: Type -> Type # Methods from :: UpdateAPI mode -> Rep (UpdateAPI mode) x # to :: Rep (UpdateAPI mode) x -> UpdateAPI mode #
type Rep (UpdateAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (UpdateAPI mode) = D1 ('MetaData "UpdateAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "UpdateAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "updateNodeEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " Update node according to NodeType params" :> AsyncJobs JobLog '[JSON] UpdateNodeParams JobLog)))))

newtype MoveAPI mode #

Constructors

MoveAPI
Fields moveNodeEp :: mode :- (Summary "Move Node endpoint" :> (Capture "parent_id" ParentId :> Put '[JSON] [Int]))

Instances

Instances details

Generic (MoveAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (MoveAPI mode) :: Type -> Type # Methods from :: MoveAPI mode -> Rep (MoveAPI mode) x # to :: Rep (MoveAPI mode) x -> MoveAPI mode #
type Rep (MoveAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (MoveAPI mode) = D1 ('MetaData "MoveAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "MoveAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "moveNodeEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary "Move Node endpoint" :> (Capture "parent_id" ParentId :> Put '[JSON] [Int]))))))

newtype PairingAPI mode #

Constructors

PairingAPI
Fields getPairingEp :: mode :- (Summary " Pairing API" :> (QueryParam "view" TabType :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> (QueryParam "order" OrderBy :> Get '[JSON] [FacetDoc])))))

Instances

Instances details

Generic (PairingAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (PairingAPI mode) :: Type -> Type # Methods from :: PairingAPI mode -> Rep (PairingAPI mode) x # to :: Rep (PairingAPI mode) x -> PairingAPI mode #
type Rep (PairingAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (PairingAPI mode) = D1 ('MetaData "PairingAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "PairingAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPairingEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary " Pairing API" :> (QueryParam "view" TabType :> (QueryParam "offset" Offset :> (QueryParam "limit" Limit :> (QueryParam "order" OrderBy :> Get '[JSON] [FacetDoc])))))))))

newtype PairWith mode #

Constructors

PairWith
Fields pairCorpusAnnuaireEp :: mode :- (Summary "Pair a Corpus with an Annuaire" :> ("annuaire" :> (Capture "annuaire_id" AnnuaireId :> (QueryParam "list_id" ListId :> Post '[JSON] [Int]))))

Instances

Instances details

Generic (PairWith mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (PairWith mode) :: Type -> Type # Methods from :: PairWith mode -> Rep (PairWith mode) x # to :: Rep (PairWith mode) x -> PairWith mode #
type Rep (PairWith mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (PairWith mode) = D1 ('MetaData "PairWith" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "PairWith" 'PrefixI 'True) (S1 ('MetaSel ('Just "pairCorpusAnnuaireEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary "Pair a Corpus with an Annuaire" :> ("annuaire" :> (Capture "annuaire_id" AnnuaireId :> (QueryParam "list_id" ListId :> Post '[JSON] [Int]))))))))

newtype Pairs mode #

Constructors

Pairs
Fields pairsListEp :: mode :- (Summary "List of Pairs" :> Get '[JSON] [AnnuaireId])

Instances

Instances details

Generic (Pairs mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (Pairs mode) :: Type -> Type # Methods from :: Pairs mode -> Rep (Pairs mode) x # to :: Rep (Pairs mode) x -> Pairs mode #
type Rep (Pairs mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (Pairs mode) = D1 ('MetaData "Pairs" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "Pairs" 'PrefixI 'True) (S1 ('MetaSel ('Just "pairsListEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary "List of Pairs" :> Get '[JSON] [AnnuaireId])))))

data Roots mode #

Constructors

Roots
Fields getRootsEp :: mode :- Get '[JSON] [Node HyperdataUser] putRootsEp :: mode :- Put '[JSON] Int

Instances

Instances details

Generic (Roots mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (Roots mode) :: Type -> Type # Methods from :: Roots mode -> Rep (Roots mode) x # to :: Rep (Roots mode) x -> Roots mode #
type Rep (Roots mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (Roots mode) = D1 ('MetaData "Roots" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Roots" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRootsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- Get '[JSON] [Node HyperdataUser])) :*: S1 ('MetaSel ('Just "putRootsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- Put '[JSON] Int))))

newtype NodesAPI mode #

Constructors

NodesAPI
Fields deleteNodeEp :: mode :- Delete '[JSON] Int

Instances

Instances details

Generic (NodesAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep (NodesAPI mode) :: Type -> Type # Methods from :: NodesAPI mode -> Rep (NodesAPI mode) x # to :: Rep (NodesAPI mode) x -> NodesAPI mode #
type Rep (NodesAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep (NodesAPI mode) = D1 ('MetaData "NodesAPI" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "NodesAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteNodeEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- Delete '[JSON] Int))))

API types (might appear in the routes)

data Charts #

Constructors

Sources
Authors
Institutes
Ngrams
All

Instances

Instances details

Bounded Charts #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods minBound :: Charts # maxBound :: Charts #
Enum Charts #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods succ :: Charts -> Charts # pred :: Charts -> Charts # toEnum :: Int -> Charts # fromEnum :: Charts -> Int # enumFrom :: Charts -> [Charts] # enumFromThen :: Charts -> Charts -> [Charts] # enumFromTo :: Charts -> Charts -> [Charts] # enumFromThenTo :: Charts -> Charts -> Charts -> [Charts] #
Generic Charts #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep Charts :: Type -> Type # Methods from :: Charts -> Rep Charts x # to :: Rep Charts x -> Charts #
Eq Charts #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods (==) :: Charts -> Charts -> Bool # (/=) :: Charts -> Charts -> Bool #
Ord Charts #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods compare :: Charts -> Charts -> Ordering # (<) :: Charts -> Charts -> Bool # (<=) :: Charts -> Charts -> Bool # (>) :: Charts -> Charts -> Bool # (>=) :: Charts -> Charts -> Bool # max :: Charts -> Charts -> Charts # min :: Charts -> Charts -> Charts #
type Rep Charts #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep Charts = D1 ('MetaData "Charts" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) ((C1 ('MetaCons "Sources" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Authors" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Institutes" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Ngrams" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "All" 'PrefixI 'False) (U1 :: Type -> Type))))

data Granularity #

Constructors

NewNgrams
NewTexts
Both

Instances

Instances details

Bounded Granularity #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods minBound :: Granularity # maxBound :: Granularity #
Enum Granularity #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods succ :: Granularity -> Granularity # pred :: Granularity -> Granularity # toEnum :: Int -> Granularity # fromEnum :: Granularity -> Int # enumFrom :: Granularity -> [Granularity] # enumFromThen :: Granularity -> Granularity -> [Granularity] # enumFromTo :: Granularity -> Granularity -> [Granularity] # enumFromThenTo :: Granularity -> Granularity -> Granularity -> [Granularity] #
Generic Granularity #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep Granularity :: Type -> Type # Methods from :: Granularity -> Rep Granularity x # to :: Rep Granularity x -> Granularity #
Eq Granularity #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods (==) :: Granularity -> Granularity -> Bool # (/=) :: Granularity -> Granularity -> Bool #
Ord Granularity #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods compare :: Granularity -> Granularity -> Ordering # (<) :: Granularity -> Granularity -> Bool # (<=) :: Granularity -> Granularity -> Bool # (>) :: Granularity -> Granularity -> Bool # (>=) :: Granularity -> Granularity -> Bool # max :: Granularity -> Granularity -> Granularity # min :: Granularity -> Granularity -> Granularity #
type Rep Granularity #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep Granularity = D1 ('MetaData "Granularity" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "NewNgrams" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NewTexts" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Both" 'PrefixI 'False) (U1 :: Type -> Type)))

data Method #

Constructors

Basic
Advanced
WithModel

Instances

Instances details

Bounded Method #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods minBound :: Method # maxBound :: Method #
Enum Method #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods succ :: Method -> Method # pred :: Method -> Method # toEnum :: Int -> Method # fromEnum :: Method -> Int # enumFrom :: Method -> [Method] # enumFromThen :: Method -> Method -> [Method] # enumFromTo :: Method -> Method -> [Method] # enumFromThenTo :: Method -> Method -> Method -> [Method] #
Generic Method #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
Eq Method #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Ord Method #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods compare :: Method -> Method -> Ordering # (<) :: Method -> Method -> Bool # (<=) :: Method -> Method -> Bool # (>) :: Method -> Method -> Bool # (>=) :: Method -> Method -> Bool # max :: Method -> Method -> Method # min :: Method -> Method -> Method #
type Rep Method #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep Method = D1 ('MetaData "Method" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "Basic" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Advanced" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "WithModel" 'PrefixI 'False) (U1 :: Type -> Type)))

data NodesToCategory #

Constructors

NodesToCategory
Fields ntc_nodesId :: [NodeId] ntc_category :: Int

Instances

Instances details

Generic NodesToCategory #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep NodesToCategory :: Type -> Type # Methods from :: NodesToCategory -> Rep NodesToCategory x # to :: Rep NodesToCategory x -> NodesToCategory #
type Rep NodesToCategory #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep NodesToCategory = D1 ('MetaData "NodesToCategory" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "NodesToCategory" 'PrefixI 'True) (S1 ('MetaSel ('Just "ntc_nodesId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [NodeId]) :*: S1 ('MetaSel ('Just "ntc_category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

data PostNode #

Constructors

PostNode
Fields pn_name :: Text pn_typename :: NodeType

Instances

Instances details

Arbitrary PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods arbitrary :: Gen PostNode # shrink :: PostNode -> [PostNode] #
FromJSON PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods parseJSON :: Value -> Parser PostNode # parseJSONList :: Value -> Parser [PostNode] #
ToJSON PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods toJSON :: PostNode -> Value # toEncoding :: PostNode -> Encoding # toJSONList :: [PostNode] -> Value # toEncodingList :: [PostNode] -> Encoding #
Generic PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep PostNode :: Type -> Type # Methods from :: PostNode -> Rep PostNode x # to :: Rep PostNode x -> PostNode #
FromForm PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods fromForm :: Form -> Either Text PostNode #
ToForm PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods toForm :: PostNode -> Form #
ToSchema PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Methods declareNamedSchema :: Proxy PostNode -> Declare (Definitions Schema) NamedSchema #
type Rep PostNode #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep PostNode = D1 ('MetaData "PostNode" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "PostNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "pn_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "pn_typename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeType)))

newtype RenameNode #

Constructors

RenameNode
Fields r_name :: Text

Instances

Instances details

Generic RenameNode #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep RenameNode :: Type -> Type # Methods from :: RenameNode -> Rep RenameNode x # to :: Rep RenameNode x -> RenameNode #
type Rep RenameNode #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep RenameNode = D1 ('MetaData "RenameNode" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "RenameNode" 'PrefixI 'True) (S1 ('MetaSel ('Just "r_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data UpdateNodeParams #

Constructors

UpdateNodeParamsList
Fields methodList :: !Method
UpdateNodeParamsGraph
Fields methodGraphMetric :: !GraphMetric methodGraphClustering :: !PartitionMethod methodGraphBridgeness :: !BridgenessMethod methodGraphEdgesStrength :: !Strength methodGraphNodeType1 :: !NgramsType methodGraphNodeType2 :: !NgramsType
UpdateNodeParamsTexts
Fields methodTexts :: !Granularity
UpdateNodeParamsBoard
Fields methodBoard :: !Charts
LinkNodeReq
Fields nodeType :: !NodeType id :: !NodeId
UpdateNodePhylo
Fields config :: !PhyloSubConfigAPI

Instances

Instances details

Generic UpdateNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.Node Associated Types type Rep UpdateNodeParams :: Type -> Type # Methods from :: UpdateNodeParams -> Rep UpdateNodeParams x # to :: Rep UpdateNodeParams x -> UpdateNodeParams #
type Rep UpdateNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.Node type Rep UpdateNodeParams = D1 ('MetaData "UpdateNodeParams" "Gargantext.API.Routes.Named.Node" "gargantext-0.0.7.1.5.3-inplace" 'False) ((C1 ('MetaCons "UpdateNodeParamsList" 'PrefixI 'True) (S1 ('MetaSel ('Just "methodList") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Method)) :+: (C1 ('MetaCons "UpdateNodeParamsGraph" 'PrefixI 'True) ((S1 ('MetaSel ('Just "methodGraphMetric") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GraphMetric) :: (S1 ('MetaSel ('Just "methodGraphClustering") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PartitionMethod) :: S1 ('MetaSel ('Just "methodGraphBridgeness") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BridgenessMethod))) :: (S1 ('MetaSel ('Just "methodGraphEdgesStrength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Strength) :: (S1 ('MetaSel ('Just "methodGraphNodeType1") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NgramsType) :: S1 ('MetaSel ('Just "methodGraphNodeType2") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NgramsType)))) :+: C1 ('MetaCons "UpdateNodeParamsTexts" 'PrefixI 'True) (S1 ('MetaSel ('Just "methodTexts") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Granularity)))) :+: (C1 ('MetaCons "UpdateNodeParamsBoard" 'PrefixI 'True) (S1 ('MetaSel ('Just "methodBoard") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Charts)) :+: (C1 ('MetaCons "LinkNodeReq" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NodeType) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NodeId)) :+: C1 ('MetaCons "UpdateNodePhylo" 'PrefixI 'True) (S1 ('MetaSel ('Just "config") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PhyloSubConfigAPI)))))