refactor: update module docstrings for clarity and consistency
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
"""Export the backend OpenAPI schema to a versioned JSON artifact."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
@@ -11,11 +13,13 @@ from app.main import app # noqa: E402
|
||||
|
||||
|
||||
def main() -> None:
|
||||
# Importing the FastAPI app does not run lifespan hooks, so this does not require a DB.
|
||||
"""Generate `openapi.json` from the FastAPI app definition."""
|
||||
# Importing the FastAPI app does not run lifespan hooks,
|
||||
# so this does not require a DB.
|
||||
out_path = BACKEND_ROOT / "openapi.json"
|
||||
payload = app.openapi()
|
||||
out_path.write_text(json.dumps(payload, indent=2, sort_keys=True), encoding="utf-8")
|
||||
print(str(out_path))
|
||||
sys.stdout.write(f"{out_path}\n")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
Reference in New Issue
Block a user