feat(model-server): add known specific operationIds

Author: nkoester

api/model-server.yaml

@@ -24,18 +24,21 @@ paths:
   /v2/server-id:
     get:
       description: ""
+      operationId: getServerId
       responses:
         "200":
           $ref: '#/components/responses/200'
   /v2/user-id:
     get:
       description: ""
+      operationId: getUserId
       responses:
         "200":
           $ref: '#/components/responses/200'
   /v2/generate-client-id:
     post:
       description: ""
+      operationId: postGenerateClientId
       responses:
         "200":
           $ref: '#/components/responses/200'
@@ -66,12 +69,14 @@ paths:
   /v2/repositories:
     get:
       description: ""
+      operationId: getRepositories
       responses:
         "200":
           $ref: '#/components/responses/200'
   /v2/repositories/{repository}/branches:
     get:
       description: ""
+      operationId: getRepositoryBranches
       parameters:
         - name: repository
           in: "path"
@@ -84,6 +89,7 @@ paths:
   /v2/repositories/{repository}/branches/{branch}:
     get:
       description: ""
+      operationId: getRepositoryBranch
       parameters:
         - name: lastKnown
           in: "query"
@@ -142,6 +148,7 @@ paths:
   /v2/repositories/{repository}/branches/{branch}/hash:
     get:
       description: ""
+      operationId: getRepositoryBranchHash
       parameters:
         - name: repository
           in: "path"
@@ -299,6 +306,7 @@ paths:
   /v2/repositories/{repository}/init:
     post:
       description: ""
+      operationId: initializeRepository
       parameters:
         - name: useRoleIds
           in: "query"
@@ -326,6 +334,7 @@ paths:
   /v2/repositories/{repository}/versions/{versionHash}:
     get:
       description: ""
+      operationId: getRepositoryVersionHash
       parameters:
         - name: lastKnown
           in: "query"

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

@@ -162,6 +162,7 @@ object Main {
                 installAuthentication(unitTestMode = !KeycloakUtils.isEnabled())
                 install(ForwardedHeaders)
                 install(Resources)
+                // https://opensource.zalando.com/restful-api-guidelines/#136
                 install(IgnoreTrailingSlash)
                 install(WebSockets) {
                     pingPeriod = Duration.ofSeconds(30)

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

@@ -76,30 +76,30 @@ class ModelReplicationServer(val repositoriesManager: RepositoriesManager) {
     }
 
     private fun Route.installHandlers() {
-        post<Paths.v2GenerateClientIdPost> {
+        post<Paths.postGenerateClientId> {
             call.respondText(storeClient.generateId("clientId").toString())
         }
-        get<Paths.v2ServerIdGet> {
+        get<Paths.getServerId> {
             call.respondText(repositoriesManager.getServerId())
         }
-        get<Paths.v2ServerIdGet> {
+        get<Paths.getServerId> {
             call.respondText(repositoriesManager.getServerId())
         }
-        get<Paths.v2UserIdGet> {
+        get<Paths.getUserId> {
             call.respondText(call.getUserName() ?: call.request.origin.remoteHost)
         }
-        get<Paths.v2RepositoriesGet> {
+        get<Paths.getRepositories> {
             call.respondText(repositoriesManager.getRepositories().joinToString("\n") { it.id })
         }
 
-        get<Paths.v2RepositoriesRepositoryBranchesGet> {
+        get<Paths.getRepositoryBranches> {
             fun ApplicationCall.repositoryId() = RepositoryId(parameters["repository"]!!)
             fun PipelineContext<Unit, ApplicationCall>.repositoryId() = call.repositoryId()
 
             call.respondText(repositoriesManager.getBranchNames(repositoryId()).joinToString("\n"))
         }
 
-        get<Paths.v2RepositoriesRepositoryBranchesBranchGet> {
+        get<Paths.getRepositoryBranch> {
             fun ApplicationCall.repositoryId() = RepositoryId(parameters["repository"]!!)
             fun PipelineContext<Unit, ApplicationCall>.repositoryId() = call.repositoryId()
 
@@ -119,7 +119,7 @@ class ModelReplicationServer(val repositoriesManager: RepositoriesManager) {
             call.respondDelta(versionHash, baseVersionHash)
         }
 
-        get<Paths.v2RepositoriesRepositoryBranchesBranchHashGet> {
+        get<Paths.getRepositoryBranchHash> {
             fun ApplicationCall.repositoryId() = RepositoryId(parameters["repository"]!!)
             fun PipelineContext<Unit, ApplicationCall>.repositoryId() = call.repositoryId()
 
@@ -138,7 +138,7 @@ class ModelReplicationServer(val repositoriesManager: RepositoriesManager) {
             call.respondText(versionHash)
         }
 
-        post<Paths.v2RepositoriesRepositoryInitPost> {
+        post<Paths.initializeRepository> {
             fun ApplicationCall.repositoryId() = RepositoryId(parameters["repository"]!!)
             fun PipelineContext<Unit, ApplicationCall>.repositoryId() = call.repositoryId()
 
@@ -208,7 +208,7 @@ class ModelReplicationServer(val repositoriesManager: RepositoriesManager) {
             }
         }
 
-        get<Paths.v2RepositoriesRepositoryVersionsVersionHashGet> {
+        get<Paths.getRepositoryVersionHash> {
             fun ApplicationCall.repositoryId() = RepositoryId(parameters["repository"]!!)
             fun PipelineContext<Unit, ApplicationCall>.repositoryId() = call.repositoryId()