moves openapi specs to docs folder

nucleuscloud · Oct 24, 2024 · b1545d6 · b1545d6
1 parent c3727a3
commit b1545d6
Show file tree

Hide file tree

Showing 13 changed files with 11 additions and 97 deletions.
diff --git a/backend/scripts/gen.sh b/backend/scripts/gen.sh
diff --git a/buf.gen.yaml b/buf.gen.yaml
@@ -38,7 +38,7 @@ plugins:
     opt: json,proto_docs.json
 
   - local: protoc-gen-connect-openapi
-    out: backend/gen/openapi
+    out: docs/openapi
     opt:
       - content-types=json
 

diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
@@ -113,39 +113,39 @@ const config: Config = {
       {
         specs: [
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/anonymization.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/anonymization.openapi.yaml',
             route: '/reference/anonymization',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/api_key.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/api_key.openapi.yaml',
             route: '/reference/api_key',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/auth.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/auth.openapi.yaml',
             route: '/reference/auth',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/connection_data.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/connection_data.openapi.yaml',
             route: '/reference/connection_data',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/connection.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/connection.openapi.yaml',
             route: '/reference/connection',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/job.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/job.openapi.yaml',
             route: '/reference/job',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/metrics.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/metrics.openapi.yaml',
             route: '/reference/metrics',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/transformer.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/transformer.openapi.yaml',
             route: '/reference/transformer',
           },
           {
-            spec: '../backend/gen/openapi/mgmt/v1alpha1/user_account.openapi.yaml',
+            spec: 'openapi/mgmt/v1alpha1/user_account.openapi.yaml',
             route: '/reference/user_account',
           },
         ],

diff --git a/.../mgmt/v1alpha1/anonymization.openapi.yaml → .../mgmt/v1alpha1/anonymization.openapi.yaml b/.../mgmt/v1alpha1/anonymization.openapi.yaml → .../mgmt/v1alpha1/anonymization.openapi.yaml
diff --git a/...penapi/mgmt/v1alpha1/api_key.openapi.yaml → ...penapi/mgmt/v1alpha1/api_key.openapi.yaml b/...penapi/mgmt/v1alpha1/api_key.openapi.yaml → ...penapi/mgmt/v1alpha1/api_key.openapi.yaml
diff --git a/...n/openapi/mgmt/v1alpha1/auth.openapi.yaml → docs/openapi/mgmt/v1alpha1/auth.openapi.yaml b/...n/openapi/mgmt/v1alpha1/auth.openapi.yaml → docs/openapi/mgmt/v1alpha1/auth.openapi.yaml
diff --git a/...api/mgmt/v1alpha1/connection.openapi.yaml → ...api/mgmt/v1alpha1/connection.openapi.yaml b/...api/mgmt/v1alpha1/connection.openapi.yaml → ...api/mgmt/v1alpha1/connection.openapi.yaml
diff --git a/...gmt/v1alpha1/connection_data.openapi.yaml → ...gmt/v1alpha1/connection_data.openapi.yaml b/...gmt/v1alpha1/connection_data.openapi.yaml → ...gmt/v1alpha1/connection_data.openapi.yaml
diff --git a/...en/openapi/mgmt/v1alpha1/job.openapi.yaml → docs/openapi/mgmt/v1alpha1/job.openapi.yaml b/...en/openapi/mgmt/v1alpha1/job.openapi.yaml → docs/openapi/mgmt/v1alpha1/job.openapi.yaml
diff --git a/...penapi/mgmt/v1alpha1/metrics.openapi.yaml → ...penapi/mgmt/v1alpha1/metrics.openapi.yaml b/...penapi/mgmt/v1alpha1/metrics.openapi.yaml → ...penapi/mgmt/v1alpha1/metrics.openapi.yaml
diff --git a/...pi/mgmt/v1alpha1/transformer.openapi.yaml → ...pi/mgmt/v1alpha1/transformer.openapi.yaml b/...pi/mgmt/v1alpha1/transformer.openapi.yaml → ...pi/mgmt/v1alpha1/transformer.openapi.yaml
diff --git a/...i/mgmt/v1alpha1/user_account.openapi.yaml → ...i/mgmt/v1alpha1/user_account.openapi.yaml b/...i/mgmt/v1alpha1/user_account.openapi.yaml → ...i/mgmt/v1alpha1/user_account.openapi.yaml
diff --git a/scripts/backend-gen.sh b/scripts/backend-gen.sh
@@ -50,6 +50,7 @@ BUF_GENERATE_CMD="$BUF_GENERATE_CMD \
   --volume \"./backend/gen:/workspace/backend/gen\" \
   --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 \"./python/src/neosync:/workspace/python/src/neosync\" \
   --volume \"./buf.yaml:/workspace/buf.yaml\" \
   --volume \"./buf.lock:/workspace/buf.lock\" \