renamed removed by retired

Author: pcrespov

packages/common-library/src/common_library/changelog.py

@@ -21,7 +21,7 @@ class ChangelogType(Enum):
     NEW = auto()
     CHANGED = auto()
     DEPRECATED = auto()
-    REMOVED = auto()
+    RETIRED = auto()
 
 
 class ChangelogEntry(ABC):
@@ -94,17 +94,17 @@ def get_version(self) -> Version | None:
         return Version(self.version) if self.version else None
 
 
-class RemovedEndpoint(ChangelogEntry):
+class RetiredEndpoint(ChangelogEntry):
     """Indicates when an endpoint will be or was removed"""
 
-    entry_type = ChangelogType.REMOVED
+    entry_type = ChangelogType.RETIRED
 
     def __init__(self, version: str, message: str):
         self.version = version
         self.message = message
 
     def to_string(self) -> str:
-        return f"Removed in *version {self.version}*: {self.message}\n"
+        return f"Retired in *version {self.version}*: {self.message}\n"
 
     def get_version(self) -> Version:
         return Version(self.version)
@@ -227,7 +227,7 @@ def create_route_config(
     for entry in changelog_list:
         if entry.entry_type == ChangelogType.DEPRECATED:
             is_deprecated = True
-        elif entry.entry_type == ChangelogType.REMOVED:
+        elif entry.entry_type == ChangelogType.RETIRED:
             is_removed = True
 
     # Set route options based on endpoint state

packages/common-library/tests/test_changelog.py

@@ -10,7 +10,7 @@
     ChangelogType,
     DeprecatedEndpoint,
     NewEndpoint,
-    RemovedEndpoint,
+    RetiredEndpoint,
     create_route_config,
     create_route_description,
     validate_changelog,
@@ -28,7 +28,7 @@ def current_api_version(mocker: MockerFixture) -> str:
 def test_changelog_entry_types():
     assert ChangelogType.NEW.value < ChangelogType.CHANGED.value
     assert ChangelogType.CHANGED.value < ChangelogType.DEPRECATED.value
-    assert ChangelogType.DEPRECATED.value < ChangelogType.REMOVED.value
+    assert ChangelogType.DEPRECATED.value < ChangelogType.RETIRED.value
 
 
 def test_changelog_entry_classes():
@@ -59,11 +59,11 @@ def test_changelog_entry_classes():
     assert "Deprecated" in deprecated_no_version.to_string()
     assert "in *version" not in deprecated_no_version.to_string()
 
-    # Test RemovedEndpoint
-    removed_entry = RemovedEndpoint("0.9.0", "Use the new endpoint instead")
-    assert removed_entry.entry_type == ChangelogType.REMOVED
+    # Test RetiredEndpoint
+    removed_entry = RetiredEndpoint("0.9.0", "Use the new endpoint instead")
+    assert removed_entry.entry_type == ChangelogType.RETIRED
     assert removed_entry.get_version() == Version("0.9.0")
-    assert "Removed in *version 0.9.0*" in removed_entry.to_string()
+    assert "Retired in *version 0.9.0*" in removed_entry.to_string()
     assert "Use the new endpoint instead" in removed_entry.to_string()
 
 
@@ -181,7 +181,7 @@ def test_create_route_config_with_removal_notice(current_api_version: str) -> No
     changelog = [
         NewEndpoint("0.5.0"),
         DeprecatedEndpoint(alternative_route),
-        RemovedEndpoint("0.9.0", removal_message),
+        RetiredEndpoint("0.9.0", removal_message),
     ]
 
     config = create_route_config(
@@ -232,7 +232,7 @@ def test_create_route_config_with_mixed_changelog(current_api_version: str) -> N
         ChangedEndpoint("0.6.0", "Added authentication"),
         ChangedEndpoint("0.6.2", "Fixed a bug"),
         DeprecatedEndpoint(alternative_route),
-        RemovedEndpoint("0.9.0", "Use the new endpoint instead"),
+        RetiredEndpoint("0.9.0", "Use the new endpoint instead"),
     ]
 
     config = create_route_config(