Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Routes.Named.Private

Contents

Routes types

Synopsis

data GargPrivateAPI mode
data GargPrivateAPI' mode = GargPrivateAPI' {
- gargAdminAPI :: mode :- NamedRoutes GargAdminAPI
- nodeEp :: mode :- NamedRoutes NodeEndpoint
- contextEp :: mode :- ("context" :> (Summary "Node endpoint" :> (Capture "node_id" ContextId :> NamedRoutes (ContextAPI HyperdataAny))))
- corpusNodeAPI :: mode :- ("corpus" :> (Summary "Corpus endpoint" :> (Capture "corpus_id" CorpusId :> NamedRoutes (NodeAPI HyperdataCorpus))))
- corpusNodeNodeAPI :: mode :- ("corpus" :> (Summary "Corpus endpoint" :> (Capture "node1_id" NodeId :> ("document" :> (Capture "node2_id" NodeId :> NamedRoutes (NodeNodeAPI HyperdataAny))))))
- corpusExportAPI :: mode :- ("corpus" :> (Capture "node_id" CorpusId :> NamedRoutes CorpusExportAPI))
- annuaireEp :: mode :- ("annuaire" :> (Summary "Annuaire endpoint" :> (Capture "annuaire_id" AnnuaireId :> NamedRoutes (NodeAPI HyperdataAnnuaire))))
- contactAPI :: mode :- ("annuaire" :> (Summary "Contact endpoint" :> (Capture "annuaire_id" NodeId :> NamedRoutes ContactAPI)))
- tableNgramsAPI :: mode :- ("document" :> (Summary "Document endpoint" :> (Capture "doc_id" DocId :> ("ngrams" :> NamedRoutes TableNgramsAPI))))
- documentExportAPI :: mode :- ("texts" :> (Capture "node_id" DocId :> NamedRoutes DocumentExportAPI))
- countAPI :: mode :- ("count" :> (Summary "Count endpoint" :> (ReqBody '[JSON] Query :> NamedRoutes CountAPI)))
- graphAPI :: mode :- ("graph" :> (Summary "Graph endpoint" :> (Capture "graph_id" NodeId :> NamedRoutes GraphAPI)))
- treeAPI :: mode :- ("tree" :> (Summary "Tree endpoint" :> (Capture "tree_id" NodeId :> PolicyChecked (NamedRoutes TreeAPI))))
- treeFlatAPI :: mode :- ("treeflat" :> (Summary "Flat tree endpoint" :> (Capture "tree_id" NodeId :> NamedRoutes TreeFlatAPI)))
- membersAPI :: mode :- ("members" :> (Summary "Team node members" :> NamedRoutes MembersAPI))
- addWithFormEp :: mode :- NamedRoutes AddWithForm
- addWithQueryEp :: mode :- NamedRoutes AddWithQuery
- listGetAPI :: mode :- NamedRoutes GETAPI
- listJsonAPI :: mode :- NamedRoutes JSONAPI
- listCsvAPI :: mode :- NamedRoutes CSVAPI
- shareUrlEp :: mode :- ("shareurl" :> NamedRoutes ShareURL)
}
data GargAdminAPI mode = GargAdminAPI {
- rootsEp :: mode :- ("user" :> (Summary "First user endpoint" :> NamedRoutes Roots))
- adminNodesAPI :: mode :- ("nodes" :> (Summary "Nodes endpoint" :> (ReqBody '[JSON] [NodeId] :> NamedRoutes NodesAPI)))
}
data NodeEndpoint mode = NodeEndpoint {
- nodeEndpointAPI :: mode :- ("node" :> (Summary "Node endpoint" :> (Capture "node_id" NodeId :> NamedRoutes (NodeAPI HyperdataAny))))
}
data MembersAPI mode = MembersAPI {
- getMembersEp :: mode :- Get '[JSON] [Text]
}

Routes types

data GargPrivateAPI mode #

Instances

Instances details

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

data GargPrivateAPI' mode #

Constructors

GargPrivateAPI'

Fields

gargAdminAPI :: mode :- NamedRoutes GargAdminAPI
nodeEp :: mode :- NamedRoutes NodeEndpoint
contextEp :: mode :- ("context" :> (Summary "Node endpoint" :> (Capture "node_id" ContextId :> NamedRoutes (ContextAPI HyperdataAny))))
corpusNodeAPI :: mode :- ("corpus" :> (Summary "Corpus endpoint" :> (Capture "corpus_id" CorpusId :> NamedRoutes (NodeAPI HyperdataCorpus))))
corpusNodeNodeAPI :: mode :- ("corpus" :> (Summary "Corpus endpoint" :> (Capture "node1_id" NodeId :> ("document" :> (Capture "node2_id" NodeId :> NamedRoutes (NodeNodeAPI HyperdataAny))))))
corpusExportAPI :: mode :- ("corpus" :> (Capture "node_id" CorpusId :> NamedRoutes CorpusExportAPI))
annuaireEp :: mode :- ("annuaire" :> (Summary "Annuaire endpoint" :> (Capture "annuaire_id" AnnuaireId :> NamedRoutes (NodeAPI HyperdataAnnuaire))))
contactAPI :: mode :- ("annuaire" :> (Summary "Contact endpoint" :> (Capture "annuaire_id" NodeId :> NamedRoutes ContactAPI)))
tableNgramsAPI :: mode :- ("document" :> (Summary "Document endpoint" :> (Capture "doc_id" DocId :> ("ngrams" :> NamedRoutes TableNgramsAPI))))
documentExportAPI :: mode :- ("texts" :> (Capture "node_id" DocId :> NamedRoutes DocumentExportAPI))
countAPI :: mode :- ("count" :> (Summary "Count endpoint" :> (ReqBody '[JSON] Query :> NamedRoutes CountAPI)))
graphAPI :: mode :- ("graph" :> (Summary "Graph endpoint" :> (Capture "graph_id" NodeId :> NamedRoutes GraphAPI)))
treeAPI :: mode :- ("tree" :> (Summary "Tree endpoint" :> (Capture "tree_id" NodeId :> PolicyChecked (NamedRoutes TreeAPI))))
treeFlatAPI :: mode :- ("treeflat" :> (Summary "Flat tree endpoint" :> (Capture "tree_id" NodeId :> NamedRoutes TreeFlatAPI)))
membersAPI :: mode :- ("members" :> (Summary "Team node members" :> NamedRoutes MembersAPI))
addWithFormEp :: mode :- NamedRoutes AddWithForm
addWithQueryEp :: mode :- NamedRoutes AddWithQuery
listGetAPI :: mode :- NamedRoutes GETAPI
listJsonAPI :: mode :- NamedRoutes JSONAPI
listCsvAPI :: mode :- NamedRoutes CSVAPI
shareUrlEp :: mode :- ("shareurl" :> NamedRoutes ShareURL)

Instances

Instances details

Generic (GargPrivateAPI' mode) #
Instance details Defined in Gargantext.API.Routes.Named.Private Associated Types type Rep (GargPrivateAPI' mode) :: Type -> Type # Methods from :: GargPrivateAPI' mode -> Rep (GargPrivateAPI' mode) x # to :: Rep (GargPrivateAPI' mode) x -> GargPrivateAPI' mode #
type Rep (GargPrivateAPI' mode) #
Instance details Defined in Gargantext.API.Routes.Named.Private type Rep (GargPrivateAPI' mode) = D1 ('MetaData "GargPrivateAPI'" "Gargantext.API.Routes.Named.Private" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GargPrivateAPI'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "gargAdminAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes GargAdminAPI)) :: S1 ('MetaSel ('Just "nodeEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes NodeEndpoint))) :: (S1 ('MetaSel ('Just "contextEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("context" :> (Summary "Node endpoint" :> (Capture "node_id" ContextId :> NamedRoutes (ContextAPI HyperdataAny)))))) :: (S1 ('MetaSel ('Just "corpusNodeAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("corpus" :> (Summary "Corpus endpoint" :> (Capture "corpus_id" CorpusId :> NamedRoutes (NodeAPI HyperdataCorpus)))))) :: S1 ('MetaSel ('Just "corpusNodeNodeAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("corpus" :> (Summary "Corpus endpoint" :> (Capture "node1_id" NodeId :> ("document" :> (Capture "node2_id" NodeId :> NamedRoutes (NodeNodeAPI HyperdataAny))))))))))) :: ((S1 ('MetaSel ('Just "corpusExportAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("corpus" :> (Capture "node_id" CorpusId :> NamedRoutes CorpusExportAPI)))) :: S1 ('MetaSel ('Just "annuaireEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("annuaire" :> (Summary "Annuaire endpoint" :> (Capture "annuaire_id" AnnuaireId :> NamedRoutes (NodeAPI HyperdataAnnuaire))))))) :: (S1 ('MetaSel ('Just "contactAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("annuaire" :> (Summary "Contact endpoint" :> (Capture "annuaire_id" NodeId :> NamedRoutes ContactAPI))))) :: (S1 ('MetaSel ('Just "tableNgramsAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("document" :> (Summary "Document endpoint" :> (Capture "doc_id" DocId :> ("ngrams" :> NamedRoutes TableNgramsAPI)))))) :: S1 ('MetaSel ('Just "documentExportAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("texts" :> (Capture "node_id" DocId :> NamedRoutes DocumentExportAPI)))))))) :: (((S1 ('MetaSel ('Just "countAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("count" :> (Summary "Count endpoint" :> (ReqBody '[JSON] Query :> NamedRoutes CountAPI))))) :: S1 ('MetaSel ('Just "graphAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("graph" :> (Summary "Graph endpoint" :> (Capture "graph_id" NodeId :> NamedRoutes GraphAPI)))))) :: (S1 ('MetaSel ('Just "treeAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("tree" :> (Summary "Tree endpoint" :> (Capture "tree_id" NodeId :> PolicyChecked (NamedRoutes TreeAPI)))))) :: (S1 ('MetaSel ('Just "treeFlatAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("treeflat" :> (Summary "Flat tree endpoint" :> (Capture "tree_id" NodeId :> NamedRoutes TreeFlatAPI))))) :: S1 ('MetaSel ('Just "membersAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("members" :> (Summary "Team node members" :> NamedRoutes MembersAPI))))))) :: ((S1 ('MetaSel ('Just "addWithFormEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes AddWithForm)) :: (S1 ('MetaSel ('Just "addWithQueryEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes AddWithQuery)) :: S1 ('MetaSel ('Just "listGetAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes GETAPI)))) :: (S1 ('MetaSel ('Just "listJsonAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes JSONAPI)) :: (S1 ('MetaSel ('Just "listCsvAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- NamedRoutes CSVAPI)) :: S1 ('MetaSel ('Just "shareUrlEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("shareurl" :> NamedRoutes ShareURL)))))))))

data GargAdminAPI mode #

Constructors

GargAdminAPI
Fields rootsEp :: mode :- ("user" :> (Summary "First user endpoint" :> NamedRoutes Roots)) adminNodesAPI :: mode :- ("nodes" :> (Summary "Nodes endpoint" :> (ReqBody '[JSON] [NodeId] :> NamedRoutes NodesAPI)))

Instances

Instances details

Generic (GargAdminAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Private Associated Types type Rep (GargAdminAPI mode) :: Type -> Type # Methods from :: GargAdminAPI mode -> Rep (GargAdminAPI mode) x # to :: Rep (GargAdminAPI mode) x -> GargAdminAPI mode #
type Rep (GargAdminAPI mode) #
Instance details Defined in Gargantext.API.Routes.Named.Private type Rep (GargAdminAPI mode) = D1 ('MetaData "GargAdminAPI" "Gargantext.API.Routes.Named.Private" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "GargAdminAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "rootsEp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("user" :> (Summary "First user endpoint" :> NamedRoutes Roots)))) :*: S1 ('MetaSel ('Just "adminNodesAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("nodes" :> (Summary "Nodes endpoint" :> (ReqBody '[JSON] [NodeId] :> NamedRoutes NodesAPI)))))))

data NodeEndpoint mode #

Constructors

NodeEndpoint
Fields nodeEndpointAPI :: mode :- ("node" :> (Summary "Node endpoint" :> (Capture "node_id" NodeId :> NamedRoutes (NodeAPI HyperdataAny))))

Instances

Instances details

Generic (NodeEndpoint mode) #
Instance details Defined in Gargantext.API.Routes.Named.Private Associated Types type Rep (NodeEndpoint mode) :: Type -> Type # Methods from :: NodeEndpoint mode -> Rep (NodeEndpoint mode) x # to :: Rep (NodeEndpoint mode) x -> NodeEndpoint mode #
type Rep (NodeEndpoint mode) #
Instance details Defined in Gargantext.API.Routes.Named.Private type Rep (NodeEndpoint mode) = D1 ('MetaData "NodeEndpoint" "Gargantext.API.Routes.Named.Private" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "NodeEndpoint" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodeEndpointAPI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (mode :- ("node" :> (Summary "Node endpoint" :> (Capture "node_id" NodeId :> NamedRoutes (NodeAPI HyperdataAny))))))))

data MembersAPI mode #

Constructors

MembersAPI
Fields getMembersEp :: mode :- Get '[JSON] [Text]