CM-34678 - Add Remediation Guidelines and Description to JSON output (#…

…218)
cycodehq · Apr 5, 2024 · e1e159c · e1e159c
1 parent ee6d006
commit e1e159c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/cycode/cli/commands/scan/code_scanner.py b/cycode/cli/commands/scan/code_scanner.py
@@ -146,6 +146,8 @@ def _enrich_scan_result_with_data_from_detection_rules(
 
             # detection_details never was typed properly. so not a problem for now
             detection.detection_details['custom_remediation_guidelines'] = detection_rule.custom_remediation_guidelines
+            detection.detection_details['remediation_guidelines'] = detection_rule.remediation_guidelines
+            detection.detection_details['description'] = detection_rule.description
 
 
 def _get_scan_documents_thread_func(

diff --git a/cycode/cyclient/models.py b/cycode/cyclient/models.py
@@ -440,6 +440,8 @@ class DetectionRule:
     classification_data: List[ClassificationData]
     detection_rule_id: str
     custom_remediation_guidelines: Optional[str] = None
+    remediation_guidelines: Optional[str] = None
+    description: Optional[str] = None
 
 
 class DetectionRuleSchema(Schema):
@@ -449,6 +451,8 @@ class Meta:
     classification_data = fields.Nested(ClassificationDataSchema, many=True)
     detection_rule_id = fields.String()
     custom_remediation_guidelines = fields.String(allow_none=True)
+    remediation_guidelines = fields.String(allow_none=True)
+    description = fields.String(allow_none=True)
 
     @post_load
     def build_dto(self, data: Dict[str, Any], **_) -> DetectionRule: