generate openapi

pkgs/clan-cli/bin/gen-openapi

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+import argparse
+import json
+import sys
+from pathlib import Path
+
+from uvicorn.importer import import_from_string
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(prog="gen-openapi")
+    parser.add_argument(
+        "app", help='App import string. Eg. "main:app"', default="main:app"
+    )
+    parser.add_argument("--app-dir", help="Directory containing the app", default=None)
+    parser.add_argument(
+        "--out", help="Output file ending in .json", default="openapi.json"
+    )
+    args = parser.parse_args()
+
+    if args.app_dir is not None:
+        print(f"adding {args.app_dir} to sys.path")
+        sys.path.insert(0, args.app_dir)
+
+    print(f"importing app from {args.app}")
+    app = import_from_string(args.app)
+    openapi = app.openapi()
+    version = openapi.get("openapi", "unknown version")
+
+    print(f"writing openapi spec v{version}")
+    out = Path(args.out)
+    out.parent.mkdir(parents=True, exist_ok=True)
+    out.write_text(json.dumps(openapi, indent=2))
+
+
+if __name__ == "__main__":
+    main()

pkgs/clan-cli/clan_cli/webui/app.py

@@ -1,8 +1,19 @@
 from fastapi import FastAPI
+from fastapi.routing import APIRoute
 
 from .routers import health, machines, root
 
-app = FastAPI()
-app.include_router(health.router)
-app.include_router(machines.router)
-app.include_router(root.router)
+
+def setup_app() -> FastAPI:
+    app = FastAPI()
+    app.include_router(health.router)
+    app.include_router(machines.router)
+    app.include_router(root.router)
+
+    for route in app.routes:
+        if isinstance(route, APIRoute):
+            route.operation_id = route.name  # in this case, 'read_items'
+    return app
+
+
+app = setup_app()

pkgs/clan-cli/clan_cli/webui/routers/health.py

@@ -3,6 +3,6 @@ from fastapi import APIRouter
 router = APIRouter()
 
 
-@router.get("/health")
+@router.get("/health", include_in_schema=False)
 async def health() -> str:
     return "OK"

pkgs/clan-cli/default.nix

@@ -73,6 +73,13 @@ python3.pkgs.buildPythonPackage {
     NIX_STATE_DIR=$TMPDIR/nix ${checkPython}/bin/python -m pytest -s ./tests
     touch $out
   '';
+  passthru.clan-openapi = runCommand "clan-openapi" { } ''
+    cp -r ${source} ./src
+    chmod +w -R ./src
+    cd ./src
+    ${checkPython}/bin/python ./bin/gen-openapi --out $out/openapi.json --app-dir . clan_cli.webui.app:app
+    touch $out
+  '';
 
   passthru.devDependencies = [
     setuptools

pkgs/clan-cli/flake-module.nix

@@ -9,6 +9,7 @@
         inherit self;
         zerotierone = self'.packages.zerotierone;
       };
+      clan-openapi = self'.packages.clan-cli.clan-openapi;
       default = self'.packages.clan-cli;
 
       ## Optional dependencies for clan cli, we re-expose them here to make sure they all build.