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

Gargantext.API.Node.Share

Description

 

Documentation

data ShareNodeParams #

Constructors

ShareTeamParams 

Fields

SharePublicParams 

Fields

Instances

Instances details
Arbitrary ShareNodeParams # 
Instance details

Defined in Gargantext.API.Node.Share

Methods

arbitrary :: Gen ShareNodeParams #

shrink :: ShareNodeParams -> [ShareNodeParams] #

FromJSON ShareNodeParams # 
Instance details

Defined in Gargantext.API.Node.Share

Methods

parseJSON :: Value -> Parser ShareNodeParams #

parseJSONList :: Value -> Parser [ShareNodeParams] #

ToJSON ShareNodeParams # 
Instance details

Defined in Gargantext.API.Node.Share

Methods

toJSON :: ShareNodeParams -> Value #

toEncoding :: ShareNodeParams -> Encoding #

toJSONList :: [ShareNodeParams] -> Value #

toEncodingList :: [ShareNodeParams] -> Encoding #

Generic ShareNodeParams # 
Instance details

Defined in Gargantext.API.Node.Share

Associated Types

type Rep ShareNodeParams :: Type -> Type #

Methods

from :: ShareNodeParams -> Rep ShareNodeParams x #

to :: Rep ShareNodeParams x -> ShareNodeParams #

ToSchema ShareNodeParams # 
Instance details

Defined in Gargantext.API.Node.Share

Methods

declareNamedSchema :: Proxy ShareNodeParams -> Declare (Definitions Schema) NamedSchema #

HasSwagger (WithCustomErrorScheme GargAPI) # 
Instance details

Defined in Gargantext.API.Routes

Methods

toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #

type Rep ShareNodeParams # 
Instance details

Defined in Gargantext.API.Node.Share

type Rep ShareNodeParams = D1 ('MetaData "ShareNodeParams" "Gargantext.API.Node.Share" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ShareTeamParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "SharePublicParams" 'PrefixI 'True) (S1 ('MetaSel ('Just "node_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeId)))

api :: (HasNodeError err, HasNLPServer env, CmdRandom env err m) => User -> NodeId -> ShareNodeParams -> m Int #

type API = Summary " Share Node with username" :> (ReqBody '[JSON] ShareNodeParams :> Post '[JSON] Int) #

type Unpublish = Summary " Unpublish Node" :> (Capture "node_id" NodeId :> Put '[JSON] Int) #

unPublish :: NodeId -> GargServer Unpublish #