Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Share

Contents

Routes types
API types (which appears in the routes)

Synopsis

newtype ShareNode mode = ShareNode {
- shareNodeEp :: mode :- (Summary " Share Node with username" :> (ReqBody '[JSON] ShareNodeParams :> Post '[JSON] Int))
}
newtype Unpublish mode = Unpublish {
- unpublishEp :: mode :- (Summary " Unpublish Node" :> (Capture "node_id" NodeId :> Put '[JSON] Int))
}
newtype ShareURL mode = ShareURL {
- shareUrlEp :: mode :- (Summary "Fetch URL for sharing a node" :> (QueryParam "type" NodeType :> (QueryParam "id" NodeId :> Get '[JSON] Text)))
}
data ShareNodeParams
- = ShareTeamParams {
  - username :: Text
  }
- | SharePublicParams {
  - node_id :: NodeId
  }

Routes types

newtype ShareNode mode #

Constructors

ShareNode
Fields shareNodeEp :: mode :- (Summary " Share Node with username" :> (ReqBody '[JSON] ShareNodeParams :> Post '[JSON] Int))

Instances

Instances details

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

newtype Unpublish mode #

Constructors

Unpublish
Fields unpublishEp :: mode :- (Summary " Unpublish Node" :> (Capture "node_id" NodeId :> Put '[JSON] Int))

Instances

Instances details

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

newtype ShareURL mode #

Constructors

ShareURL
Fields shareUrlEp :: mode :- (Summary "Fetch URL for sharing a node" :> (QueryParam "type" NodeType :> (QueryParam "id" NodeId :> Get '[JSON] Text)))

Instances

Instances details

Generic (ShareURL mode) #
Instance details Defined in Gargantext.API.Routes.Named.Share Associated Types type Rep (ShareURL mode) :: Type -> Type # Methods from :: ShareURL mode -> Rep (ShareURL mode) x # to :: Rep (ShareURL mode) x -> ShareURL mode #
type Rep (ShareURL mode) #
Instance details Defined in Gargantext.API.Routes.Named.Share type Rep (ShareURL mode) = D1 ('MetaData "ShareURL" "Gargantext.API.Routes.Named.Share" "gargantext-0.0.7.1.5.3-inplace" 'True) (C1 ('MetaCons "ShareURL" 'PrefixI 'True) (S1 ('MetaSel ('Just "shareUrlEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (mode :- (Summary "Fetch URL for sharing a node" :> (QueryParam "type" NodeType :> (QueryParam "id" NodeId :> Get '[JSON] Text)))))))

API types (which appears in the routes)

data ShareNodeParams #

Constructors

ShareTeamParams
Fields username :: Text
SharePublicParams
Fields node_id :: NodeId

Instances

Instances details

Arbitrary ShareNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.Share Methods arbitrary :: Gen ShareNodeParams # shrink :: ShareNodeParams -> [ShareNodeParams] #
FromJSON ShareNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.Share Methods parseJSON :: Value -> Parser ShareNodeParams # parseJSONList :: Value -> Parser [ShareNodeParams] #
ToJSON ShareNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.Share Methods toJSON :: ShareNodeParams -> Value # toEncoding :: ShareNodeParams -> Encoding # toJSONList :: [ShareNodeParams] -> Value # toEncodingList :: [ShareNodeParams] -> Encoding #
Generic ShareNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.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.Routes.Named.Share Methods declareNamedSchema :: Proxy ShareNodeParams -> Declare (Definitions Schema) NamedSchema #
type Rep ShareNodeParams #
Instance details Defined in Gargantext.API.Routes.Named.Share type Rep ShareNodeParams = D1 ('MetaData "ShareNodeParams" "Gargantext.API.Routes.Named.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)))