Merge pull request #48 from GitGuardian/alina/include-incident-url

feat(api): parse incident_url from the multiscan endpoint

Author: agateau-gg

changelog.d/20230403_154257_alina.tuholukova_include_incident_url.md

@@ -0,0 +1,42 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Removed
+
+- A bullet item for the Removed category.
+
+-->
+
+### Added
+
+- PolicyBreak now includes the URL of the policy break if the dashboard already knows about it.
+
+<!--
+### Changed
+
+- A bullet item for the Deprecated category.
+
+-->
+
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category.
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->

pygitguardian/models.py

@@ -206,6 +206,7 @@ class PolicyBreakSchema(BaseSchema):
     policy = fields.String(required=True)
     validity = fields.String(required=False, load_default=None, dump_default=None)
     known_secret = fields.Boolean(required=False, load_default=False, dump_default=None)
+    incident_url = fields.String(required=False, load_default=False, dump_default=None)
     matches = fields.List(fields.Nested(MatchSchema), required=True)
 
     @post_load
@@ -230,13 +231,15 @@ def __init__(
         validity: str,
         matches: List[Match],
         known_secret: bool = False,
+        incident_url: Optional[str] = None,
         **kwargs: Any,
     ) -> None:
         super().__init__()
         self.break_type = break_type
         self.policy = policy
         self.validity = validity
         self.known_secret = known_secret
+        self.incident_url = incident_url
         self.matches = matches
 
     @property

tests/test_models.py

@@ -91,6 +91,18 @@ def test_document_handle_surrogates(self):
                     "matches": [{"match": "hello", "type": "hello"}],
                 },
             ),
+            (
+                PolicyBreakSchema,
+                PolicyBreak,
+                {
+                    "type": "hello",
+                    "policy": "hello",
+                    "validity": "hey",
+                    "known_secret": True,
+                    "incident_url": "https://api.gitguardian.com/workspace/2/incidents/3",
+                    "matches": [{"match": "hello", "type": "hello"}],
+                },
+            ),
             (
                 QuotaSchema,
                 Quota,