Merge OpenAPI Specs (#136)

* merge openapi specs and delete public api

* fix openapi difference + fix scripts + fix yaml

* pop at end of script

* remove working directory from spec generation commands

* make sure yaml binaries are built

* add --output-yaml instead of --output

* template before worker

* delete temp spec yamls after merge

* update openapi client generator

Author: nicoburniske

.github/workflows/ci.yaml

@@ -27,14 +27,14 @@ jobs:
             build-config: ""
           - platform: linux/arm64
             target: aarch64-unknown-linux-gnu
-            build-config: "--config \"target.aarch64-unknown-linux-gnu.linker = 'aarch64-linux-gnu-gcc'\""
+            build-config: '--config "target.aarch64-unknown-linux-gnu.linker = ''aarch64-linux-gnu-gcc''"'
     name: docker-targets-build (${{ matrix.platform.platform }})
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           submodules: recursive
-          fetch-depth: '0'
+          fetch-depth: "0"
       - name: Prepare
         run: |
           platform=${{ matrix.platform.platform }}
@@ -89,7 +89,7 @@ jobs:
         uses: actions/checkout@v3
         with:
           submodules: recursive
-          fetch-depth: '0'
+          fetch-depth: "0"
       - name: Prepare
         run: |
           echo "PLATFORMS=linux/amd64,linux/arm64" >> $GITHUB_ENV
@@ -294,7 +294,8 @@ jobs:
           path: |
             target/release/golem-template-service
             target/release/golem-worker-service
-            target/release/golem-service-yaml
+            target/release/golem-worker-service-yaml
+            target/release/golem-template-service-yaml
             target/release/golem-shard-manager
             target/release/worker-executor
   integration-tests:
@@ -332,9 +333,15 @@ jobs:
           path: ./target/debug/
       - name: Restore executable flag
         run: chmod a+x ./target/debug/*
-      - name: Generate Golem OpenAPI yaml
-        working-directory: golem-public-api
-        run: ../target/debug/golem-service-yaml > ../target/golem-service.yaml
+      - name: Generate golem-template-service OpenAPI yaml
+        run: ./target/debug/golem-template-service-yaml > ./target/golem-template-service.yaml
+      - name: Generate golem-worker-service OpenAPI yaml
+        run: ./target/debug/golem-worker-service-yaml > ./target/golem-worker-service.yaml
+      - name: Merge openapi specs
+        working-directory: golem-openapi-client-generator
+        run: |
+          cargo build
+          ./target/debug/golem-openapi-client-generator merge --spec-yaml ../target/golem-template-service.yaml ../target/golem-worker-service.yaml --output-yaml ../target/golem-service.yaml
       - name: Check Golem OpenAPI yaml latest
         shell: bash
         run: |
@@ -351,7 +358,7 @@ jobs:
         run: |
           expected_version=$( ../scripts/expected-client-version.sh )
           cargo build
-          ./target/debug/golem-openapi-client-generator --spec-yaml ../openapi/golem-service.yaml --output-directory ../golem-client --name "golem-client" --client-version "${expected_version}"
+          ./target/debug/golem-openapi-client-generator generate --spec-yaml ../openapi/golem-service.yaml --output-directory ../golem-client --name "golem-client" --client-version "${expected_version}"
       - name: Integration tests
         working-directory: golem-cli
         env:

Cargo.lock

@@ -10,7 +10,6 @@ members = [
     "golem-template-service",
     "golem-shard-manager",
     "golem-worker-service",
-    "golem-public-api"
 ]
 
 exclude = [
@@ -45,7 +44,7 @@ exclude = [
     "golem-client",
     "golem-cli",
     "libtest-mimic",
-    "wasm-rpc"
+    "wasm-rpc",
 ]
 
 [workspace.dependencies]
@@ -59,7 +58,11 @@ chrono = { version = "0.4.32", features = ["serde"] }
 console-subscriber = "0.2.0"
 dashmap = "5.5.3"
 figment = { version = "0.10.14", features = ["toml", "env"] }
-fred = { version = "8.0.0", features = ["metrics", "serde-json", "partial-tracing"] }
+fred = { version = "8.0.0", features = [
+    "metrics",
+    "serde-json",
+    "partial-tracing",
+] }
 futures = "0.3"
 futures-core = "0.3.29"
 futures-util = "0.3.29"
@@ -73,7 +76,15 @@ poem = "2.0.0"
 opentelemetry = "0.21.0"
 opentelemetry-prometheus = "0.14.1"
 opentelemetry_sdk = "0.21.2"
-poem-openapi = { version = "4.0.0", features = ["swagger-ui", "chrono", "time", "humantime", "uuid", "url", "websocket"] }
+poem-openapi = { version = "4.0.0", features = [
+    "swagger-ui",
+    "chrono",
+    "time",
+    "humantime",
+    "uuid",
+    "url",
+    "websocket",
+] }
 prometheus = { version = "0.13.3", features = ["process"] }
 proptest = "1.4.0"
 prost = "0.12.3"
@@ -82,15 +93,27 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0" }
 tempfile = "3.9.0"
 thiserror = "1.0.56"
-tokio = { version = "1.0", features = ["macros", "rt-multi-thread", "sync", "io-std", "net", "tracing"] }
+tokio = { version = "1.0", features = [
+    "macros",
+    "rt-multi-thread",
+    "sync",
+    "io-std",
+    "net",
+    "tracing",
+] }
 tokio-rustls = { version = "0.25.0" }
 tokio-stream = { version = "0.1", features = ["sync"] }
 tonic = "0.10.2"
 tonic-reflection = "0.10.2"
 tonic-health = "0.10.2"
 tracing = { version = "0.1.40", features = ["log"] }
 tracing-opentelemetry = "0.22.0"
-tracing-subscriber = { version = "0.3.17", features = ["env-filter", "fmt", "std", "json"] }
+tracing-subscriber = { version = "0.3.17", features = [
+    "env-filter",
+    "fmt",
+    "std",
+    "json",
+] }
 url = "2.5.0"
 uuid = { version = "1.7.0", features = ["serde", "v4"] }
 warp = "0.3.6"

Cargo.toml

@@ -21,12 +21,12 @@ pub struct VersionInfo {
 
 #[OpenApi(prefix_path = "/", tag = ApiTags::HealthCheck)]
 impl HealthcheckApi {
-    #[oai(path = "/healthcheck", method = "get")]
+    #[oai(path = "/healthcheck", method = "get", operation_id = "healthcheck")]
     async fn healthcheck(&self) -> Json<HealthcheckResponse> {
         Json(HealthcheckResponse {})
     }
 
-    #[oai(path = "/version", method = "get")]
+    #[oai(path = "/version", method = "get", operation_id = "version")]
     async fn version(&self) -> Json<VersionInfo> {
         Json(VersionInfo {
             version: VERSION.to_string(),