feat: refined workspaces API while implementing it

Author: slisson

api-server-stubs-ktor/build.gradle.kts

@@ -30,6 +30,9 @@ fabrikt {
             suspendModifier = enabled
             completionStage = enabled
         }
+        typeOverrides {
+            uuid = String
+        }
     }
     generate("mavenConnector") {
         apiFile = rootProject.layout.projectDirectory.file("redocly/build/bundled/maven-connector-v1.yaml")
@@ -39,6 +42,10 @@ fabrikt {
         apiFile = rootProject.layout.projectDirectory.file("redocly/build/bundled/repository-v3.yaml")
         basePackage = "org.modelix.services.repository.stubs"
     }
+    generate("workspaces") {
+        apiFile = rootProject.layout.projectDirectory.file("redocly/build/bundled/workspaces-v1.yaml")
+        basePackage = "org.modelix.services.workspaces.stubs"
+    }
 }
 
 tasks.withType<FabriktGenerateTask> {

build.gradle.kts

@@ -30,9 +30,9 @@ subprojects {
     apply(plugin = "maven-publish")
 
     repositories {
-        mavenLocal()
         maven { url = uri("https://artifacts.itemis.cloud/repository/maven-mps/") }
         mavenCentral()
+        mavenLocal()
     }
 
     publishing {

client-ts/build.gradle.kts

@@ -40,6 +40,7 @@ fun registerNpmPackageTasks(
                     "npmRepository" to "https://artifacts.itemis.cloud/repository/npm-open/",
                     "npmVersion" to project.version.toString(),
                     "npmName" to "@modelix/$npmPackageName",
+                    "supportsES6" to "true",
                 )
             gitUserId = "modelix"
             gitRepoId = "modelix.openapi"

package.json

@@ -17,5 +17,6 @@
   },
   "dependencies": {
     "@stoplight/spectral-cli": "^6.14.2"
-  }
+  },
+  "packageManager": "[email protected]+sha512.0486e394640d3c1fb3c9d43d49cf92879ff74f8516959c235308f5a8f62e2e19528a65cdc2a3058f587cde71eba3d5b56327c8c33a97e4c4051ca48a10ca2d5f"
 }

redocly/package.json

@@ -8,6 +8,7 @@
   },
   "scripts": {
     "bundle": "redocly bundle",
-    "join": "redocly join build/bundled/**/*.yaml --output=build/joined.yaml"
+    "join": "redocly join build/bundled/**/*.yaml --output=build/joined.yaml",
+    "bundle-and-join": "$npm_execpath run bundle && $npm_execpath run join"
   }
 }

redocly/redocly.yaml

@@ -12,3 +12,8 @@ apis:
     output: ./build/bundled/maven-connector-v1.yaml
     decorators:
       plugin/use-server-path: {}
+  workspaces@v1:
+    root: ../specifications/workspaces/v1/workspaces.yaml
+    output: ./build/bundled/workspaces-v1.yaml
+    decorators:
+      plugin/use-server-path: {}

specifications/maven-connector/v1/maven.yaml

@@ -3,15 +3,17 @@ info:
   title: "Modelix Maven Connector"
   version: "1.0.0"
 servers:
-  - url: '/api/modelix/maven-connector'
+  - url: '/modelix/maven-connector'
     description: Makes artifacts from maven repositories available to other services
 tags:
   - name: MavenConnector
+  - name: MavenRepositories
+  - name: MavenArtifacts
 paths:
   /:
     get:
       operationId: getMavenConnectorConfig
-      tags: [MavenConnector]
+      tags: [MavenRepositories, MavenArtifacts]
       responses:
         "200":
           description: OK
@@ -22,6 +24,7 @@ paths:
   /repositories/:
     get:
       operationId: listMavenRepositories
+      tags: [MavenRepositories]
       responses:
         "200":
           description: OK
@@ -32,7 +35,7 @@ paths:
   /repositories/{repositoryId}:
     get:
       operationId: getMavenRepository
-      tags: [MavenConnector]
+      tags: [MavenRepositories]
       parameters:
         - name: repositoryId
           in: path
@@ -48,7 +51,7 @@ paths:
                 $ref: '#/components/schemas/MavenRepository'
     put:
       operationId: updateMavenRepository
-      tags: [MavenConnector]
+      tags: [MavenRepositories]
       parameters:
         - name: repositoryId
           in: path
@@ -65,7 +68,7 @@ paths:
           description: OK
     delete:
       operationId: deleteMavenRepository
-      tags: [MavenConnector]
+      tags: [MavenRepositories]
       parameters:
         - name: repositoryId
           in: path
@@ -78,14 +81,76 @@ paths:
   /artifacts/:
     get:
       operationId: listMavenArtifacts
-      tags: [MavenConnector]
+      tags: [MavenArtifacts]
       responses:
         "200":
           description: OK
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/MavenArtifactList'
+  /artifacts/{groupId}/{artifactId}:
+    get:
+      operationId: getMavenArtifact
+      tags: [MavenArtifacts]
+      parameters:
+        - name: groupId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: artifactId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MavenArtifact'
+    put:
+      operationId: updateMavenArtifact
+      tags: [MavenArtifacts]
+      parameters:
+        - name: groupId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: artifactId
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MavenArtifact'
+      responses:
+        "200":
+          description: OK
+    delete:
+      operationId: deleteMavenArtifact
+      tags: [MavenArtifacts]
+      parameters:
+        - name: groupId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: artifactId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: OK
+
 components:
   schemas:
     MavenConnectorConfig:
@@ -114,10 +179,8 @@ components:
       properties:
         id:
           type: string
-          nullable: false
         url:
           type: string
-          nullable: false
     MavenArtifactList:
       type: object
       required: [artifacts]

specifications/repository/v3/repository.yaml

@@ -1,9 +1,9 @@
 openapi: "3.0.3"
 info:
-  title: "Modelix Workspaces"
+  title: "Modelix Model Repository"
   version: "3.0.0"
 servers:
-  - url: '/api/modelix/repository'
+  - url: '/modelix/repository'
     description: modelix-workspaces-manager
 tags:
   - name: Repository