Merge pull request #2115 from guardicore/2004-plugin-configuration-docstring

PluginConfiguration docstring

monkey/common/agent_configuration/agent_sub_configurations.py

@@ -27,6 +27,27 @@ class CustomPBAConfiguration:
 
 @dataclass(frozen=True)
 class PluginConfiguration:
+    """
+    A configuration for plugins
+
+    Attributes:
+        :param name: Name of the plugin
+                     Example: "ransomware"
+        :param options: Any other information/configuration fields relevant to the plugin
+                        Example: {
+                            "encryption": {
+                                "enabled": True,
+                                "directories": {
+                                    "linux_target_dir": "~/this_dir",
+                                    "windows_target_dir": "C:\that_dir"
+                                },
+                            },
+                            "other_behaviors": {
+                                "readme": True
+                            },
+                        }
+    """
+
     name: str
     options: Dict