Revize 4911f0ea

re #9577 Api code documentation.

server/sql_app/api/pcs_web.py

@@ -9 +9 @@
 from fastapi.templating import Jinja2Templates
 
 models.Base.metadata.create_all(bind=engine)
-templates = Jinja2Templates(directory="templates/pcs")
 
+# Path to html templates used in this file
+templates = Jinja2Templates(directory="../templates/pcs")
+
+# prefix used for all endpoints in this file
 pcs_web = APIRouter(prefix="/api/v1")
 
 
@@ -25 +28 @@
 
 @pcs_web.get("/pcs-web", response_class=HTMLResponse)
 async def read_pcs(request: Request, skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """
+    Returns template with all pcs currently saved in database
+    """
     pcs = crud.get_pcs(db, skip=skip, limit=limit)
     return templates.TemplateResponse("pcs.html", {"request": request, "pcs": pcs})
 
 
 @pcs_web.get("/pc-team/{pc_id}", response_class=HTMLResponse)
 async def connect_pc_team(request: Request, pc_id: int, db: Session = Depends(get_db)):
+    """
+    Returns template with Form for connecting pc with team
+    """
     pc = crud.get_pc(db, pc_id)
     teams = crud.get_teams(db, 0, 100)
     return templates.TemplateResponse("pcteam.html",
@@ -40 +49 @@
 @pcs_web.post("/pcs-web/{pc_id}", response_class=HTMLResponse)
 async def connect_post(request: Request, pc_id: int, team: str = Form(...), skip: int = 0, limit: int = 100,
                        db: Session = Depends(get_db)):
+    """
+    Endpoint called from within form for connecting pc with team. Updates certain pc with new team.
+    """
     old_pc = crud.update_pc(db, pc_id, team)
     pcs = crud.get_pcs(db, skip=skip, limit=limit)
     return templates.TemplateResponse("pcs.html", {"request": request, "pcs": pcs})