Split NodeAPIEndpoint

This commit splits the old `NodeAPIEndpoint` type into three;

* `NodeAPIEndpoint`, which will also contain the freeze endpoint;
* `AnnuaireAPIEndpoint`, which is the plain old node API without extra
  features;
* `CorpusAPIEndpoint`, which will also contain the publishin endpoint.

This split ensures that we don't add endpoints which do not belong to
all three categories, like before.

src/Gargantext/API/Node.hs

@@ -200,22 +200,22 @@ moveNode _u n p = update (Move n p)
 -------------------------------------------------------------
 
 annuaireNodeAPI :: AuthenticatedUser
-                -> Named.NodeAPIEndpoint HyperdataAnnuaire (AsServerT (GargM Env BackendInternalError))
-annuaireNodeAPI authenticatedUser = Named.NodeAPIEndpoint $ \targetNode ->
+                -> Named.AnnuaireAPIEndpoint (AsServerT (GargM Env BackendInternalError))
+annuaireNodeAPI authenticatedUser = Named.AnnuaireAPIEndpoint $ \targetNode ->
   withNamedAccess authenticatedUser (PathNode targetNode) (concreteAPI targetNode)
   where
     concreteAPI = genericNodeAPI' (Proxy :: Proxy HyperdataAnnuaire) authenticatedUser
 
 corpusNodeAPI :: AuthenticatedUser
-              -> Named.NodeAPIEndpoint HyperdataCorpus (AsServerT (GargM Env BackendInternalError))
-corpusNodeAPI authenticatedUser = Named.NodeAPIEndpoint $ \targetNode ->
+              -> Named.CorpusAPIEndpoint (AsServerT (GargM Env BackendInternalError))
+corpusNodeAPI authenticatedUser = Named.CorpusAPIEndpoint $ \targetNode ->
   withNamedAccess authenticatedUser (PathNode targetNode) (concreteAPI targetNode)
   where
     concreteAPI = genericNodeAPI' (Proxy :: Proxy HyperdataCorpus) authenticatedUser
 
 ------------------------------------------------------------------------
 nodeAPI :: AuthenticatedUser
-        -> Named.NodeAPIEndpoint HyperdataAny (AsServerT (GargM Env BackendInternalError))
+        -> Named.NodeAPIEndpoint (AsServerT (GargM Env BackendInternalError))
 nodeAPI authenticatedUser = Named.NodeAPIEndpoint $ \targetNode ->
   withNamedAccess authenticatedUser (PathNode targetNode) (concreteAPI targetNode)
   where

src/Gargantext/API/Routes/Named/Private.hs

@@ -11,14 +11,13 @@ module Gargantext.API.Routes.Named.Private (
   , GargAdminAPI(..)
   , NodeAPIEndpoint(..)
   , MembersAPI(..)
-  , IsGenericNodeRoute(..)
+  , AnnuaireAPIEndpoint(..)
+  , CorpusAPIEndpoint(..)
   ) where
 
 
-import Data.Kind
 import Data.Text (Text)
 import GHC.Generics
-import GHC.TypeLits
 import Gargantext.API.Admin.Auth.Types
 import Gargantext.API.Auth.PolicyCheck
 import Gargantext.API.Routes.Named.Contact
@@ -49,11 +48,11 @@ newtype GargPrivateAPI mode = GargPrivateAPI
 
 data GargPrivateAPI' mode = GargPrivateAPI'
   { gargAdminAPI :: mode :- NamedRoutes GargAdminAPI
-  , nodeEp       :: mode :- NamedRoutes (NodeAPIEndpoint HyperdataAny)
+  , nodeEp       :: mode :- NamedRoutes NodeAPIEndpoint
   , contextEp    :: mode :- "context"  :> Summary "Context endpoint"
                                        :> Capture "node_id" ContextId
                                        :> NamedRoutes (ContextAPI HyperdataAny)
-  , corpusNodeAPI :: mode :- NamedRoutes (NodeAPIEndpoint HyperdataCorpus)
+  , corpusNodeAPI :: mode :- NamedRoutes CorpusAPIEndpoint
   , corpusNodeNodeAPI :: mode :- "corpus" :> Summary "Corpus endpoint"
                                           :> Capture "node1_id" NodeId
                                           :> "document"
@@ -61,7 +60,7 @@ data GargPrivateAPI' mode = GargPrivateAPI'
                                           :> NamedRoutes (NodeNodeAPI HyperdataAny)
   , corpusExportAPI :: mode :- "corpus" :> Capture "node_id" CorpusId
                                         :> NamedRoutes CorpusExportAPI
-  , annuaireEp :: mode :- NamedRoutes (NodeAPIEndpoint HyperdataAnnuaire)
+  , annuaireEp :: mode :- NamedRoutes AnnuaireAPIEndpoint
   , contactAPI :: mode :- "annuaire" :> Summary "Contact endpoint"
                                      :> Capture "annuaire_id" NodeId
                                      :> NamedRoutes ContactAPI
@@ -102,31 +101,29 @@ data GargAdminAPI mode = GargAdminAPI
                                      :> NamedRoutes NodesAPI
   } deriving Generic
 
-class IsGenericNodeRoute a where
-  type family TyToSubPath (a :: Type) :: Symbol
-  type family TyToCapture (a :: Type) :: Symbol
-  type family TyToSummary (a :: Type) :: Type
-
-instance IsGenericNodeRoute HyperdataAny where
-  type instance TyToSubPath HyperdataAny = "node"
-  type instance TyToCapture HyperdataAny = "node_id"
-  type instance TyToSummary HyperdataAny = Summary "Node endpoint"
-
-instance IsGenericNodeRoute HyperdataCorpus where
-  type instance TyToSubPath HyperdataCorpus = "corpus"
-  type instance TyToCapture HyperdataCorpus = "corpus_id"
-  type instance TyToSummary HyperdataCorpus = Summary "Corpus endpoint"
-
-instance IsGenericNodeRoute HyperdataAnnuaire where
-  type instance TyToSubPath HyperdataAnnuaire = "annuaire"
-  type instance TyToCapture HyperdataAnnuaire = "annuaire_id"
-  type instance TyToSummary HyperdataAnnuaire = Summary "Annuaire endpoint"
-
-newtype NodeAPIEndpoint a mode = NodeAPIEndpoint
-  { nodeEndpointAPI :: mode :- TyToSubPath a
-                            :> TyToSummary a
-                            :> Capture (TyToCapture a) NodeId
-                            :> NamedRoutes (NodeAPI a)
+-- | The 'Node' API, unlike the ones for annuaire and corpus,
+-- have other endpoints which should not be shared in the hierarchy,
+-- like the /freeze/ one. Similarly, a 'Corpus' API will have a
+-- '/publish' endpoint that doesn't generalise to everything.
+data NodeAPIEndpoint mode = NodeAPIEndpoint
+  { nodeEndpointAPI :: mode :- "node"
+                            :> Summary "Node endpoint"
+                            :> Capture "node_id" NodeId
+                            :> NamedRoutes (NodeAPI HyperdataAny)
+  } deriving Generic
+
+newtype AnnuaireAPIEndpoint mode = AnnuaireAPIEndpoint
+  { annuaireEndpointAPI :: mode :- "annuaire"
+                        :> Summary "Annuaire endpoint"
+                        :> Capture "annuaire_id" NodeId
+                        :> NamedRoutes (NodeAPI HyperdataAnnuaire)
+  } deriving Generic
+
+newtype CorpusAPIEndpoint mode = CorpusAPIEndpoint
+  { corpusEndpointAPI :: mode :- "corpus"
+                      :> Summary "Corpus endpoint"
+                      :> Capture "corpus_id" NodeId
+                      :> NamedRoutes (NodeAPI HyperdataCorpus)
   } deriving Generic
 
 newtype MembersAPI mode = MembersAPI