#2257: applications and services docs

src/primaite/game/game.py

@@ -296,6 +296,7 @@ class PrimaiteGame:
                     if service_type == "DatabaseService":
                         if "options" in service_cfg:
                             opt = service_cfg["options"]
+                            new_service.password = opt.get("backup_server_ip", None)
                             new_service.configure_backup(backup_server=IPv4Address(opt.get("backup_server_ip")))
                     if service_type == "FTPServer":
                         if "options" in service_cfg:
@@ -327,7 +328,7 @@ class PrimaiteGame:
                             new_application.configure(
                                 server_ip_address=IPv4Address(opt.get("server_ip")),
                                 server_password=opt.get("server_password"),
-                                payload=opt.get("payload"),
+                                payload=opt.get("payload", "DELETE"),
                                 port_scan_p_of_success=float(opt.get("port_scan_p_of_success", "0.1")),
                                 data_manipulation_p_of_success=float(opt.get("data_manipulation_p_of_success", "0.1")),
                             )

src/primaite/simulator/system/services/database/database_service.py

@@ -23,6 +23,7 @@ class DatabaseService(Service):
     """
 
     password: Optional[str] = None
+    """Password that needs to be provided by clients if they want to connect to the DatabaseService."""
 
     backup_server_ip: IPv4Address = None
     """IP address of the backup server."""
@@ -194,6 +195,8 @@ class DatabaseService(Service):
         """
         Executes the given SQL query and returns the result.
 
+        .. _Database Payload List:
+
         Possible queries:
         - SELECT : returns the data
         - DELETE : deletes the data