Revize 4911f0ea

re #9577 Api code documentation.

server/sql_app/schemas.py

@@ -14 +14 @@
 
 
 class DeviceLicense(DeviceLicenseCreate):
+    """
+    Class used for creating and reading devices_licenses entries
+    """
     id: int
 
     class Config:
@@ -30 +33 @@
 
 
 class USBLog(USBLogBase):
+    """
+    Class used for creating and reading usb_logs entries
+    """
     id: int
     device_id: int
     pc_id: int
@@ -49 +55 @@
 
 
 class Device(DeviceCreate):
+    """
+    Class used for creating and reading devices entries
+    """
     id: int
     assigned: bool
     logs: List[USBLog] = []
@@ -68 +77 @@
 
 
 class LDLog(LDLogCreate):
+    """
+    Class used for creating and reading ld_logs entries
+    """
     id: int
     head_id: int
     body_id: int
@@ -85 +97 @@
 
 
 class BodyDevice(BodyDeviceCreate):
+    """
+    Class used for creating and reading body_devices entries
+    """
     id: int
     logs: List[LDLog] = []
 
@@ -101 +116 @@
 
 
 class HeadDevice(HeadDeviceCreate):
+    """
+    Class used for creating and reading head_devices entries
+    """
     id: int
     logs: List[LDLog] = []
 
@@ -118 +136 @@
 
 
 class PC(PCCreate):
+    """
+    Class used for creating and reading pc entries
+    """
     id: int
     assigned: bool
     logs_pc: List[USBLog] = []
@@ -135 +156 @@
 
 
 class Team(TeamCreate):
+    """
+    Class used for creating and reading team entries
+    """
     id: int
     pcs: List[PC] = []
 
@@ -152 +176 @@
 
 
 class License(LicenseCreate):
+    """
+    Class used for creating and reading licenses entries
+    """
     id: int
     devices: List[DeviceLicense] = []
 
@@ -160 +187 @@
 
 
 class USBTempBase(BaseModel):
+    """
+    Class used for reading data from keyman detecting client messages
+    """
     username: str
     hostname: str
     timestamp: str
@@ -180 +210 @@
 
 
 class LDTempBase(BaseModel):
+    """
+    Class used for reading data from debugger detecting client messages
+    """
     username: str
     hostname: str
     timestamp: str