Revize 4911f0ea

re #9577 Api code documentation.

server/sql_app/api/licenses_web.py

@@ -11 +11 @@
 from fastapi.templating import Jinja2Templates
 
 models.Base.metadata.create_all(bind=engine)
-templates = Jinja2Templates(directory="templates/licenses")
-device_templates = Jinja2Templates(directory="templates/devices")
 
+# Path to html templates used in this file
+templates = Jinja2Templates(directory="../templates/licenses")
+device_templates = Jinja2Templates(directory="../templates/devices")
+
+# prefix used for all endpoints in this file
 licenses_web = APIRouter(prefix="/api/v1")
 
 
@@ -28 +31 @@
 
 @licenses_web.get("/license-create", response_class=HTMLResponse)
 async def licenses_create_web(request: Request):
+    """
+    Returns template with Form for creating new license.
+    """
     return templates.TemplateResponse("license_create.html", {"request": request})
 
 
 @licenses_web.get("/licenses-web", response_class=HTMLResponse)
 async def read_licenses_web(request: Request, skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """
+    Returns template with all licenses currently saved in database
+    """
     licenses = crud.get_licenses(db, skip=skip, limit=limit)
     return templates.TemplateResponse("licenses.html", {"request": request, "licenses": licenses})
 
@@ -40 +49 @@
 @licenses_web.post("/licenses-web", response_class=HTMLResponse)
 def create_license(request: Request, name: str = Form(...), expdate: date = Form(...), skip: int = 0, limit: int = 100,
                    db: Session = Depends(get_db)):
+    """
+    Endpoint called from create license form. Creates new license and returns template with all licenses in database
+    """
     db_license = crud.create_license(db, name, expdate)
     if db_license is None:
         print("something went wrong")