Copyright	(c) CNRS 2017-Present
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Node.Update

Description

Documentation

type API = Summary " Update node according to NodeType params" :> AsyncJobs JobLog '[JSON] UpdateNodeParams JobLog #

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

Arbitrary UpdateNodeParams #
Instance details Defined in Gargantext.API.Node.Update Methods arbitrary :: Gen UpdateNodeParams # shrink :: UpdateNodeParams -> [UpdateNodeParams] #
FromJSON UpdateNodeParams #
Instance details Defined in Gargantext.API.Node.Update Methods parseJSON :: Value -> Parser UpdateNodeParams # parseJSONList :: Value -> Parser [UpdateNodeParams] #
ToJSON UpdateNodeParams #
Instance details Defined in Gargantext.API.Node.Update Methods toJSON :: UpdateNodeParams -> Value # toEncoding :: UpdateNodeParams -> Encoding # toJSONList :: [UpdateNodeParams] -> Value # toEncodingList :: [UpdateNodeParams] -> Encoding #
Generic UpdateNodeParams #
Instance details Defined in Gargantext.API.Node.Update Associated Types type Rep UpdateNodeParams :: Type -> Type # Methods from :: UpdateNodeParams -> Rep UpdateNodeParams x # to :: Rep UpdateNodeParams x -> UpdateNodeParams #
ToSchema UpdateNodeParams #
Instance details Defined in Gargantext.API.Node.Update Methods declareNamedSchema :: Proxy UpdateNodeParams -> Declare (Definitions Schema) NamedSchema #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
type Rep UpdateNodeParams #
Instance details Defined in Gargantext.API.Node.Update type Rep UpdateNodeParams = D1 ('MetaData "UpdateNodeParams" "Gargantext.API.Node.Update" "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)))))

data Method #

Constructors

Basic
Advanced
WithModel

Instances

Instances details

Arbitrary Method #
Instance details Defined in Gargantext.API.Node.Update Methods arbitrary :: Gen Method # shrink :: Method -> [Method] #
FromJSON Method #
Instance details Defined in Gargantext.API.Node.Update Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] #
ToJSON Method #
Instance details Defined in Gargantext.API.Node.Update Methods toJSON :: Method -> Value # toEncoding :: Method -> Encoding # toJSONList :: [Method] -> Value # toEncodingList :: [Method] -> Encoding #
Bounded Method #
Instance details Defined in Gargantext.API.Node.Update Methods minBound :: Method # maxBound :: Method #
Enum Method #
Instance details Defined in Gargantext.API.Node.Update 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.Node.Update 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.Node.Update Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Ord Method #
Instance details Defined in Gargantext.API.Node.Update 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 #
ToSchema Method #
Instance details Defined in Gargantext.API.Node.Update Methods declareNamedSchema :: Proxy Method -> Declare (Definitions Schema) NamedSchema #
type Rep Method #
Instance details Defined in Gargantext.API.Node.Update type Rep Method = D1 ('MetaData "Method" "Gargantext.API.Node.Update" "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 Granularity #

Constructors

NewNgrams
NewTexts
Both

Instances

Instances details

Arbitrary Granularity #
Instance details Defined in Gargantext.API.Node.Update Methods arbitrary :: Gen Granularity # shrink :: Granularity -> [Granularity] #
FromJSON Granularity #
Instance details Defined in Gargantext.API.Node.Update Methods parseJSON :: Value -> Parser Granularity # parseJSONList :: Value -> Parser [Granularity] #
ToJSON Granularity #
Instance details Defined in Gargantext.API.Node.Update Methods toJSON :: Granularity -> Value # toEncoding :: Granularity -> Encoding # toJSONList :: [Granularity] -> Value # toEncodingList :: [Granularity] -> Encoding #
Bounded Granularity #
Instance details Defined in Gargantext.API.Node.Update Methods minBound :: Granularity # maxBound :: Granularity #
Enum Granularity #
Instance details Defined in Gargantext.API.Node.Update 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.Node.Update 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.Node.Update Methods (==) :: Granularity -> Granularity -> Bool # (/=) :: Granularity -> Granularity -> Bool #
Ord Granularity #
Instance details Defined in Gargantext.API.Node.Update 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 #
ToSchema Granularity #
Instance details Defined in Gargantext.API.Node.Update Methods declareNamedSchema :: Proxy Granularity -> Declare (Definitions Schema) NamedSchema #
type Rep Granularity #
Instance details Defined in Gargantext.API.Node.Update type Rep Granularity = D1 ('MetaData "Granularity" "Gargantext.API.Node.Update" "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 Charts #

Constructors

Sources
Authors
Institutes
Ngrams
All

Instances

Instances details

Arbitrary Charts #
Instance details Defined in Gargantext.API.Node.Update Methods arbitrary :: Gen Charts # shrink :: Charts -> [Charts] #
FromJSON Charts #
Instance details Defined in Gargantext.API.Node.Update Methods parseJSON :: Value -> Parser Charts # parseJSONList :: Value -> Parser [Charts] #
ToJSON Charts #
Instance details Defined in Gargantext.API.Node.Update Methods toJSON :: Charts -> Value # toEncoding :: Charts -> Encoding # toJSONList :: [Charts] -> Value # toEncodingList :: [Charts] -> Encoding #
Bounded Charts #
Instance details Defined in Gargantext.API.Node.Update Methods minBound :: Charts # maxBound :: Charts #
Enum Charts #
Instance details Defined in Gargantext.API.Node.Update 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.Node.Update 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.Node.Update Methods (==) :: Charts -> Charts -> Bool # (/=) :: Charts -> Charts -> Bool #
Ord Charts #
Instance details Defined in Gargantext.API.Node.Update 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 #
ToSchema Charts #
Instance details Defined in Gargantext.API.Node.Update Methods declareNamedSchema :: Proxy Charts -> Declare (Definitions Schema) NamedSchema #
type Rep Charts #
Instance details Defined in Gargantext.API.Node.Update type Rep Charts = D1 ('MetaData "Charts" "Gargantext.API.Node.Update" "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))))

api :: NodeId -> ServerT API (GargM Env BackendInternalError) #

updateNode :: (HasNodeStory env err m, HasSettings env, MonadJobStatus m, MonadLogger m) => NodeId -> UpdateNodeParams -> JobHandle m -> m () #

updateDocs :: HasNodeStory env err m => NodeId -> m () #