refactor(model-server): drop /v2 prefix from the OpenAPI spec routes

After moving out v1 routes, we can instead declare the server to be
available as /v2.

Author: languitar

model-server-openapi/specifications/model-server-v2.yaml

@@ -13,12 +13,12 @@ info:
   description: "modelix public API"
   version: "1.0.0"
 servers:
-  - url: '/'
+  - url: '/v2'
     description: model-server
 tags:
   - name: ids
 paths:
-  /v2/server-id:
+  /server-id:
     get:
       summary: Returns the ID of the server
       tags:
@@ -29,7 +29,7 @@ paths:
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/user-id:
+  /user-id:
     get:
       tags:
         - ids
@@ -39,7 +39,7 @@ paths:
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/generate-client-id:
+  /generate-client-id:
     post:
       tags:
         - ids
@@ -49,15 +49,15 @@ paths:
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories:
+  /repositories:
     get:
       operationId: getRepositories
       responses:
         "200":
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/objects:
+  /repositories/{repository}/objects:
     put:
       operationId: putRepositoryObjects
       parameters:
@@ -75,7 +75,7 @@ paths:
           $ref: '#/components/responses/200json'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/branches:
+  /repositories/{repository}/branches:
     get:
       operationId: getRepositoryBranches
       parameters:
@@ -89,7 +89,7 @@ paths:
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/branches/{branch}:
+  /repositories/{repository}/branches/{branch}:
     delete:
       operationId: deleteRepositoryBranch
       parameters:
@@ -167,7 +167,7 @@ paths:
           $ref: '#/components/responses/versionDelta'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/branches/{branch}/hash:
+  /repositories/{repository}/branches/{branch}/hash:
     get:
       operationId: getRepositoryBranchHash
       parameters:
@@ -188,7 +188,7 @@ paths:
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/branches/{branch}/poll:
+  /repositories/{repository}/branches/{branch}/poll:
     get:
       operationId: pollRepositoryBranch
       parameters:
@@ -216,7 +216,7 @@ paths:
           $ref: '#/components/responses/versionDelta'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/branches/{branch}/pollHash:
+  /repositories/{repository}/branches/{branch}/pollHash:
     get:
       operationId: pollRepositoryBranchHash
       parameters:
@@ -249,7 +249,7 @@ paths:
           $ref: '#/components/responses/200'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/branches/{branch}/query:
+  /repositories/{repository}/branches/{branch}/query:
     post:
       operationId: postRepositoryBranchQuery
       parameters:
@@ -268,7 +268,7 @@ paths:
           $ref: '#/components/responses/200json'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/init:
+  /repositories/{repository}/init:
     post:
       operationId: initializeRepository
       parameters:
@@ -291,7 +291,7 @@ paths:
           $ref: '#/components/responses/versionDelta'
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/delete:
+  /repositories/{repository}/delete:
     post:
       operationId: deleteRepository
       parameters:
@@ -309,7 +309,7 @@ paths:
                 type: string
         "404":
           $ref: '#/components/responses/404'
-  /v2/repositories/{repository}/versions/{versionHash}:
+  /repositories/{repository}/versions/{versionHash}:
     get:
       operationId: getRepositoryVersionHash
       parameters:
@@ -339,7 +339,7 @@ paths:
                 type: object
         default:
           $ref: '#/components/responses/GeneralError'
-  /v2/repositories/{repository}/versions/{versionHash}/query:
+  /repositories/{repository}/versions/{versionHash}/query:
     post:
       operationId: postRepositoryVersionHashQuery
       parameters:
@@ -359,7 +359,7 @@ paths:
         default:
           $ref: '#/components/responses/GeneralError'
 
-  /v2/versions/{versionHash}:
+  /versions/{versionHash}:
     get:
       operationId: getVersionHash
       deprecated: true

model-server/src/main/kotlin/org/modelix/model/server/Main.kt

@@ -221,8 +221,8 @@ object Main {
                 jsonModelServer.init(this)
                 modelReplicationServer.init(this)
                 metricsApi.init(this)
+                IdsApiImpl(repositoriesManager, localModelClient).init(this)
                 routing {
-                    IdsApiImpl(repositoriesManager, localModelClient).installRoutes(this)
                     HealthApiImpl(repositoriesManager, globalStoreClient, inMemoryModels).installRoutes(this)
 
                     staticResources("/public", "public")

model-server/src/main/kotlin/org/modelix/model/server/handlers/IdsApiImpl.kt

@@ -16,10 +16,13 @@
 
 package org.modelix.model.server.handlers
 
+import io.ktor.server.application.Application
 import io.ktor.server.application.ApplicationCall
 import io.ktor.server.application.call
 import io.ktor.server.plugins.origin
 import io.ktor.server.response.respondText
+import io.ktor.server.routing.route
+import io.ktor.server.routing.routing
 import io.ktor.util.pipeline.PipelineContext
 import org.modelix.api.v2.IdsApi
 import org.modelix.authorization.getUserName
@@ -58,4 +61,14 @@ class IdsApiImpl(
     override suspend fun PipelineContext<Unit, ApplicationCall>.generateClientId() {
         call.respondText(storeClient.generateId("clientId").toString())
     }
+
+    fun init(application: Application) {
+        application.apply {
+            routing {
+                route("/v2") {
+                    installRoutes(this)
+                }
+            }
+        }
+    }
 }

model-server/src/main/kotlin/org/modelix/model/server/handlers/ModelReplicationServer.kt

@@ -31,6 +31,7 @@ import io.ktor.server.response.respond
 import io.ktor.server.response.respondBytesWriter
 import io.ktor.server.response.respondText
 import io.ktor.server.routing.Route
+import io.ktor.server.routing.route
 import io.ktor.server.routing.routing
 import io.ktor.util.cio.use
 import io.ktor.util.pipeline.PipelineContext
@@ -91,7 +92,9 @@ class ModelReplicationServer(
     fun init(application: Application) {
         application.apply {
             routing {
-                installHandlers()
+                route("/v2") {
+                    installHandlers()
+                }
             }
         }
     }

model-server/src/test/kotlin/org/modelix/model/server/ModelClientV2Test.kt

@@ -15,7 +15,6 @@
 
 package org.modelix.model.server
 
-import io.ktor.server.routing.routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
 import org.modelix.authorization.installAuthentication
@@ -54,9 +53,7 @@ class ModelClientV2Test {
             installDefaultServerPlugins()
             val storeClient = InMemoryStoreClient().forContextRepository()
             ModelReplicationServer(storeClient).init(this)
-            routing {
-                IdsApiImpl(storeClient).installRoutes(this)
-            }
+            IdsApiImpl(storeClient).init(this)
         }
         block()
     }

model-server/src/test/kotlin/org/modelix/model/server/PullPerformanceTest.kt

@@ -16,7 +16,6 @@
 
 package org.modelix.model.server
 
-import io.ktor.server.routing.routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
 import kotlinx.coroutines.coroutineScope
@@ -50,9 +49,7 @@ class PullPerformanceTest {
             installDefaultServerPlugins()
             ModelReplicationServer(repositoriesManager, LocalModelClient(storeClientWithStatistics), inMemoryModels).init(this)
             KeyValueLikeModelServer(repositoriesManager, storeClientWithStatistics.forGlobalRepository(), inMemoryModels).init(this)
-            routing {
-                IdsApiImpl(repositoriesManager, LocalModelClient(storeClientWithStatistics)).installRoutes(this)
-            }
+            IdsApiImpl(repositoriesManager, LocalModelClient(storeClientWithStatistics)).init(this)
         }
 
         coroutineScope {

model-server/src/test/kotlin/org/modelix/model/server/ReplicatedModelTest.kt

@@ -16,7 +16,6 @@
 
 package org.modelix.model.server
 
-import io.ktor.server.routing.routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
 import io.ktor.util.reflect.instanceOf
@@ -138,9 +137,7 @@ class ReplicatedModelTest {
             installDefaultServerPlugins()
             val storeClient = InMemoryStoreClient().forContextRepository()
             ModelReplicationServer(storeClient).init(this)
-            routing {
-                IdsApiImpl(storeClient).installRoutes(this)
-            }
+            IdsApiImpl(storeClient).init(this)
         }
         block()
     }

model-server/src/test/kotlin/org/modelix/model/server/ReplicatedRepositoryTest.kt

@@ -15,7 +15,6 @@
 
 package org.modelix.model.server
 
-import io.ktor.server.routing.routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
 import kotlinx.coroutines.CoroutineScope
@@ -79,9 +78,7 @@ class ReplicatedRepositoryTest {
             val inMemoryModels = InMemoryModels()
             ModelReplicationServer(repositoriesManager, modelClient, inMemoryModels).init(this)
             KeyValueLikeModelServer(repositoriesManager, storeClient.forGlobalRepository(), inMemoryModels).init(this)
-            routing {
-                IdsApiImpl(repositoriesManager, modelClient).installRoutes(this)
-            }
+            IdsApiImpl(repositoriesManager, modelClient).init(this)
         }
 
         coroutineScope {

model-server/src/test/kotlin/org/modelix/model/server/RepositoryStorageBackwardsCompatiblityTest.kt

@@ -16,7 +16,6 @@
 
 package org.modelix.model.server
 
-import io.ktor.server.routing.routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
 import org.modelix.authorization.installAuthentication
@@ -47,9 +46,7 @@ class RepositoryStorageBackwardsCompatiblityTest {
             val repositoriesManager = RepositoriesManager(LocalModelClient(store.forContextRepository()))
             KeyValueLikeModelServer(repositoriesManager, store.forGlobalRepository(), InMemoryModels()).init(this)
             ModelReplicationServer(repositoriesManager).init(this)
-            routing {
-                IdsApiImpl(repositoriesManager).installRoutes(this)
-            }
+            IdsApiImpl(repositoriesManager).init(this)
         }
         block()
     }

model-server/src/test/kotlin/org/modelix/model/server/handlers/ContentExplorerTest.kt

@@ -24,7 +24,6 @@ import io.ktor.client.statement.bodyAsText
 import io.ktor.http.ContentType
 import io.ktor.http.contentType
 import io.ktor.serialization.kotlinx.json.json
-import io.ktor.server.routing.routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
 import org.jsoup.Jsoup
@@ -59,9 +58,7 @@ class ContentExplorerTest {
             installDefaultServerPlugins()
             ModelReplicationServer(repoManager).init(this)
             ContentExplorer(modelClient, repoManager).init(this)
-            routing {
-                IdsApiImpl(repoManager, modelClient).installRoutes(this)
-            }
+            IdsApiImpl(repoManager, modelClient).init(this)
         }
         body()
     }