Revize 4911f0ea

re #9577 Api code documentation.

server/sql_app/api/devices_web.py

@@ -11 +11 @@
 from fastapi.templating import Jinja2Templates
 
 models.Base.metadata.create_all(bind=engine)
-templates = Jinja2Templates(directory="templates/devices")
 
+# Path to html templates used in this file
+templates = Jinja2Templates(directory="../templates/devices")
+
+# prefix used for all endpoints in this file
 device_web = APIRouter(prefix="/api/v1")
 
 
@@ -27 +30 @@
 
 @device_web.get("/devices-web", response_class=HTMLResponse)
 async def read_devices(request: Request, skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """
+    Returns template with all devices and its current states
+    """
     devices = crud.get_devices(db, skip=skip, limit=limit)
     statuses = []
+    # adding state for each device in list
     for i in range(0, len(devices)):
         statuses.append(devices[i].logs[len(devices[i].logs)-1].status)
     licenses = crud.get_licenses(db, skip=skip, limit=limit)
@@ -39 +46 @@
 @device_web.post("/devices-web", response_class=HTMLResponse)
 async def filter_devices(request: Request, skip: int = 0, limit: int = 100, lic: str = Form("all"),
                          db: Session = Depends(get_db)):
+    """
+    Endpoint used for filtering devices by license. returns html template with only
+    devices that has assigned license defined by user input
+    """
     devices = crud.get_devices(db, skip=skip, limit=limit)
     def_devices = []
     for dev in devices:
         for l in dev.licenses:
             if dev not in def_devices and l.licenses.name == lic:
                 def_devices.append(dev)
+    # if input was default all
     if lic == "all":
         def_devices = devices
     statuses = []
@@ -57 +69 @@
 
 @device_web.get("/device-license/{device_id}", response_class=HTMLResponse)
 async def connect_dev_lic(request: Request, device_id: int, db: Session = Depends(get_db)):
+    """
+    Returns template with one device and all available licenses that can be assigned to it.
+    """
     device = crud.get_device(db, device_id)
     licenses = crud.get_licenses(db, 0, 100)
     return templates.TemplateResponse("devicelicense.html",
@@ -66 +81 @@
 @device_web.post("/devices-web/{device_id}", response_class=HTMLResponse)
 async def connect_post(request: Request, device_id: int, lic: str = Form(...), skip: int = 0, limit: int = 100,
                        db: Session = Depends(get_db)):
+    """
+    Endpoint called from template for connecting device with license. Adds entry to devices_licenses
+    table and returns template with all devices in database
+    """
     crud.create_device_license(db, device_id, int(lic), datetime.now())
     devices = crud.get_devices(db, skip=skip, limit=limit)
     statuses = []
+    # adding state for each device in list
     for i in range(0, len(devices)):
         statuses.append(devices[i].logs[len(devices[i].logs) - 1].status)
     licenses = crud.get_licenses(db, skip=skip, limit=limit)