[DOC] Auto-generate openapi.json

.github/workflows/generate_api_docs.yaml

@@ -0,0 +1,39 @@
+name: "Generate openapi.json"
+
+env:
+  DEFAULT_PYTHON_VERSION: "3.10"
+
+on:
+  release:
+    types: [published]
+  push: # temporary, only for testing
+    branches:
+      - "gen-openapi-json"
+  workflow_dispatch:
+
+jobs:
+  update-openapi-json:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Miniconda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          environment-file: conda-store-server/environment-dev.yaml
+
+      - name: Install conda-store-server
+        run: python -m pip install conda-store-server/.
+
+      - name: Run openapi.json generation script
+        run: python docusaurus-docs/scripts/generate_openapi_json.py
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: "[AUTO] Update openapi.json"
+          title: "[AUTO] Update openapi.json"

.gitignore

@@ -54,3 +54,6 @@ conda-store-server/conda_store_server/server/static/conda-store-ui/
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# conda-store
+conda-store.sqlite

docusaurus-docs/scripts/generate_openapi_json.py

@@ -0,0 +1,32 @@
+import json
+from pathlib import Path
+
+from conda_store_server.server import app as server_app
+from fastapi.openapi.utils import get_openapi
+
+
+def gen_openapi_json():
+    cs_server = server_app.CondaStoreServer()
+    cs_server.initialize()
+    app = cs_server.init_fastapi_app()
+    filepath = Path(__file__).parent / "../static/openapi.json"
+
+    with open(filepath, "w") as f:
+        json.dump(
+            get_openapi(
+                title=app.title,
+                version=app.version,
+                openapi_version=app.openapi_version,
+                description=app.description,
+                routes=app.routes,
+            ),
+            f,
+        )
+
+
+def main():
+    gen_openapi_json()
+
+
+if __name__ == "__main__":
+    main()