Revize 4911f0ea

re #9577 Api code documentation.

server/sql_app/api/pcs.py

@@ -6 +6 @@
 
 models.Base.metadata.create_all(bind=engine)
 
+# prefix used for all endpoints in this file
 pcs = APIRouter(prefix="/api/v1")
 
 
@@ -20 +21 @@
 
 @pcs.post("/pc", response_model=schemas.PC)
 def create_pc(pc: schemas.PCCreate, db: Session = Depends(get_db)):
+    """
+    Endpoint used for creating new pc
+    """
     print(crud.create_pc(db=db, user=pc.username, host=pc.hostname))
 
 
 @pcs.get("/pcs", response_model=List[schemas.PC])
 def read_pcs(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
+    """
+    Returns all pcs currently saved in database
+    """
     pcs = crud.get_pcs(db, skip=skip, limit=limit)
     return pcs
 
 
 @pcs.get("/pc/{pc_id}", response_model=schemas.PC)
 def read_pc(pc_id: int, db: Session = Depends(get_db)):
+    """
+    Returns one specific pc by given id
+    """
     db_pc = crud.get_pc(db, pc_id=pc_id)
     if db_pc is None:
         raise HTTPException(status_code=404, detail="Device not found")