adds openapi template to add version (#2861)

nickzelei · web-flow · commit 34e6848cf70f · 2024-10-24T16:26:51.000-07:00
diff --git a/buf.gen.yaml b/buf.gen.yaml
@@ -40,7 +40,7 @@ plugins:
   - local: protoc-gen-connect-openapi
     out: docs/openapi
     opt:
-      - content-types=json
+      - content-types=json,base=neosync.openapi.template.yaml
 
   - remote: buf.build/protocolbuffers/python:v28.2 # generates messages and enums
     out: python/src/neosync
diff --git a/docs/openapi/mgmt/v1alpha1/anonymization.openapi.yaml b/docs/openapi/mgmt/v1alpha1/anonymization.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.AnonymizationService/AnonymizeMany:
diff --git a/docs/openapi/mgmt/v1alpha1/api_key.openapi.yaml b/docs/openapi/mgmt/v1alpha1/api_key.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.ApiKeyService/GetAccountApiKeys:
diff --git a/docs/openapi/mgmt/v1alpha1/auth.openapi.yaml b/docs/openapi/mgmt/v1alpha1/auth.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.AuthService/LoginCli:
diff --git a/docs/openapi/mgmt/v1alpha1/connection.openapi.yaml b/docs/openapi/mgmt/v1alpha1/connection.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.ConnectionService/GetConnections:
diff --git a/docs/openapi/mgmt/v1alpha1/connection_data.openapi.yaml b/docs/openapi/mgmt/v1alpha1/connection_data.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.ConnectionDataService/GetConnectionDataStream: {}
diff --git a/docs/openapi/mgmt/v1alpha1/job.openapi.yaml b/docs/openapi/mgmt/v1alpha1/job.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.JobService/GetJobs:
diff --git a/docs/openapi/mgmt/v1alpha1/metrics.openapi.yaml b/docs/openapi/mgmt/v1alpha1/metrics.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.MetricsService/GetDailyMetricCount:
diff --git a/docs/openapi/mgmt/v1alpha1/transformer.openapi.yaml b/docs/openapi/mgmt/v1alpha1/transformer.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.TransformersService/GetSystemTransformers:
diff --git a/docs/openapi/mgmt/v1alpha1/user_account.openapi.yaml b/docs/openapi/mgmt/v1alpha1/user_account.openapi.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: "0.4"
   title: mgmt.v1alpha1
 paths:
   /mgmt.v1alpha1.UserAccountService/GetUser:
diff --git a/docs/openapi/neosync.mgmt.v1alpha1.yaml b/docs/openapi/neosync.mgmt.v1alpha1.yaml
@@ -1,5 +1,6 @@
 openapi: 3.1.0
 info:
+  version: '0.4'
   title: mgmt.v1alpha1
 tags:
   - name: mgmt.v1alpha1.AnonymizationService
diff --git a/neosync.openapi.template.yaml b/neosync.openapi.template.yaml
@@ -0,0 +1,3 @@
+openapi: 3.1.0
+info:
+  version: 0.4
diff --git a/scripts/backend-gen.sh b/scripts/backend-gen.sh
@@ -51,6 +51,7 @@ BUF_GENERATE_CMD="$BUF_GENERATE_CMD \
   --volume \"./frontend/packages/sdk/src/client:/workspace/frontend/packages/sdk/src/client\" \
   --volume \"./docs/protos:/workspace/docs/protos\" \
   --volume \"./docs/openapi:/workspace/docs/openapi\" \
+  --volume \"./neosync.openapi.template.yaml:/workspace/neosync.openapi.template.yaml\" \
   --volume \"./python/src/neosync:/workspace/python/src/neosync\" \
   --volume \"./buf.yaml:/workspace/buf.yaml\" \
   --volume \"./buf.lock:/workspace/buf.lock\" \
