From 09a2436a46fe1885350fc87ee3e365cc5acf9ede Mon Sep 17 00:00:00 2001
From: Achille Mascia <achille.mascia@gitguardian.com>
Date: Wed, 7 May 2025 14:14:43 +0200
Subject: [PATCH] chore(nhi): rename is_secret_vaulted to is_vaulted

---
 ..._achille.mascia_rename_serializer_field.md | 41 +++++++++++++++++++
 pygitguardian/models.py                       |  8 ++--
 tests/test_models.py                          |  4 +-
 3 files changed, 46 insertions(+), 7 deletions(-)
 create mode 100644 changelog.d/20250507_141851_achille.mascia_rename_serializer_field.md

diff --git a/changelog.d/20250507_141851_achille.mascia_rename_serializer_field.md b/changelog.d/20250507_141851_achille.mascia_rename_serializer_field.md
new file mode 100644
index 00000000..564545a7
--- /dev/null
+++ b/changelog.d/20250507_141851_achille.mascia_rename_serializer_field.md
@@ -0,0 +1,41 @@
+<!--
+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
+
+- Added `is_vaulted` field to `PolicyBreak`.
+
+<!--
+### Changed
+
+- A bullet item for the Changed 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.
+
+-->
diff --git a/pygitguardian/models.py b/pygitguardian/models.py
index 00483dee..0babee2c 100644
--- a/pygitguardian/models.py
+++ b/pygitguardian/models.py
@@ -231,9 +231,7 @@ class PolicyBreakSchema(BaseSchema):
     diff_kind = fields.Enum(
         DiffKind, by_value=True, required=False, load_default=None, dump_default=None
     )
-    is_secret_vaulted = fields.Boolean(
-        required=False, load_default=False, dump_default=False
-    )
+    is_vaulted = fields.Boolean(required=False, load_default=False, dump_default=False)
 
     @post_load
     def make_policy_break(self, data: Dict[str, Any], **kwargs: Any) -> "PolicyBreak":
@@ -264,7 +262,7 @@ def __init__(
         is_excluded: bool = False,
         exclude_reason: Optional[str] = None,
         diff_kind: Optional[DiffKind] = None,
-        is_secret_vaulted: bool = False,
+        is_vaulted: bool = False,
         **kwargs: Any,
     ) -> None:
         super().__init__()
@@ -280,7 +278,7 @@ def __init__(
         self.is_excluded = is_excluded
         self.exclude_reason = exclude_reason
         self.diff_kind = diff_kind
-        self.is_secret_vaulted = is_secret_vaulted
+        self.is_vaulted = is_vaulted
 
     @property
     def is_secret(self) -> bool:
diff --git a/tests/test_models.py b/tests/test_models.py
index 5edc9c68..c46eb5d4 100644
--- a/tests/test_models.py
+++ b/tests/test_models.py
@@ -173,7 +173,7 @@ def test_document_handle_surrogates(self):
                     "is_excluded": False,
                     "exclude_reason": None,
                     "diff_kind": None,
-                    "is_secret_vaulted": False,
+                    "is_vaulted": False,
                 },
             ),
             (
@@ -192,7 +192,7 @@ def test_document_handle_surrogates(self):
                     "is_excluded": False,
                     "exclude_reason": None,
                     "diff_kind": "addition",
-                    "is_secret_vaulted": True,
+                    "is_vaulted": True,
                 },
             ),
             (