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

PluginConfiguration docstring
This commit is contained in:
Mike Salvatore 2022-07-27 07:50:30 -04:00 committed by GitHub
commit 8dc73c9739
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions

View File

@ -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