fix(sdk): hide legacy verification fields from dumps

Co-authored-by: openhands <openhands@all-hands.dev>

Author: openhands-agent

openhands-sdk/openhands/sdk/settings/model.py

@@ -9,17 +9,16 @@
 from pydantic import (
     BaseModel,
     Field,
-    PrivateAttr,
     SecretStr,
     field_serializer,
     field_validator,
+    model_serializer,
 )
 from pydantic.fields import FieldInfo
 
 from openhands.sdk.context.agent_context import AgentContext
 from openhands.sdk.llm import LLM
 from openhands.sdk.tool import Tool
-from openhands.sdk.utils.deprecation import warn_deprecated
 
 from .metadata import (
     SETTINGS_METADATA_KEY,
@@ -109,9 +108,6 @@ class CondenserSettings(BaseModel):
 class VerificationSettings(BaseModel):
     """Critic and iterative-refinement settings for the agent."""
 
-    _deprecated_confirmation_mode: bool = PrivateAttr(default=False)
-    _deprecated_security_analyzer: str | None = PrivateAttr(default=None)
-
     # -- Critic --
     critic_enabled: bool = Field(
         default=False,
@@ -202,63 +198,36 @@ class VerificationSettings(BaseModel):
         },
     )
 
-    @property
-    def confirmation_mode(self) -> bool:
-        warn_deprecated(
-            "VerificationSettings.confirmation_mode",
-            deprecated_in="1.16.1",
-            removed_in="1.18.0",
-            details=(
-                "Use ConversationSettings.confirmation_mode; "
-                "verification settings no longer serialize "
-                "conversation approval controls."
-            ),
-        )
-        return self._deprecated_confirmation_mode
-
-    @confirmation_mode.setter
-    def confirmation_mode(self, value: bool) -> None:
-        warn_deprecated(
-            "VerificationSettings.confirmation_mode",
-            deprecated_in="1.16.1",
-            removed_in="1.18.0",
-            details=(
-                "Use ConversationSettings.confirmation_mode; "
-                "verification settings no longer serialize "
-                "conversation approval controls."
-            ),
-            stacklevel=3,
-        )
-        self._deprecated_confirmation_mode = value
-
-    @property
-    def security_analyzer(self) -> str | None:
-        warn_deprecated(
-            "VerificationSettings.security_analyzer",
-            deprecated_in="1.16.1",
-            removed_in="1.18.0",
-            details=(
-                "Use ConversationSettings.security_analyzer; "
-                "verification settings no longer serialize "
-                "conversation security controls."
-            ),
-        )
-        return self._deprecated_security_analyzer
-
-    @security_analyzer.setter
-    def security_analyzer(self, value: str | None) -> None:
-        warn_deprecated(
-            "VerificationSettings.security_analyzer",
-            deprecated_in="1.16.1",
-            removed_in="1.18.0",
-            details=(
-                "Use ConversationSettings.security_analyzer; "
-                "verification settings no longer serialize "
-                "conversation security controls."
-            ),
-            stacklevel=3,
-        )
-        self._deprecated_security_analyzer = value
+    # -- Security --
+    confirmation_mode: bool = Field(
+        default=False,
+        description="Require user confirmation before executing risky actions.",
+        json_schema_extra={
+            SETTINGS_METADATA_KEY: SettingsFieldMetadata(
+                label="Confirmation mode",
+                prominence=SettingProminence.MAJOR,
+            ).model_dump()
+        },
+    )
+    security_analyzer: SecurityAnalyzerType | None = Field(
+        default=None,
+        description="Security analyzer that evaluates actions before execution.",
+        json_schema_extra={
+            SETTINGS_METADATA_KEY: SettingsFieldMetadata(
+                label="Security analyzer",
+                prominence=SettingProminence.MAJOR,
+                depends_on=("confirmation_mode",),
+            ).model_dump()
+        },
+    )
+
+    @model_serializer(mode="wrap")
+    def _serialize(self, handler):
+        payload = handler(self)
+        if isinstance(payload, dict):
+            payload.pop("confirmation_mode", None)
+            payload.pop("security_analyzer", None)
+        return payload
 
 
 def _default_llm_settings() -> LLM:
@@ -550,6 +519,19 @@ def settings_metadata(field: FieldInfo) -> SettingsFieldMetadata | None:
 _GENERAL_SECTION_LABEL = "General"
 
 
+_HIDDEN_SETTINGS_SCHEMA_FIELDS: dict[type[BaseModel], set[str]] = {
+    VerificationSettings: {"confirmation_mode", "security_analyzer"},
+}
+
+
+def _is_hidden_settings_schema_field(
+    model: type[BaseModel], field_name: str, field: FieldInfo
+) -> bool:
+    if field.exclude:
+        return True
+    return field_name in _HIDDEN_SETTINGS_SCHEMA_FIELDS.get(model, set())
+
+
 def export_settings_schema(model: type[BaseModel]) -> SettingsSchema:
     """Export a structured settings schema for a Pydantic settings model.
 
@@ -582,7 +564,9 @@ def ensure_section(key: str, label: str) -> SettingsSectionSchema:
             )
             section = ensure_section(section_metadata.key, section_label)
             for nested_key, nested_field in nested_model.model_fields.items():
-                if nested_field.exclude:
+                if _is_hidden_settings_schema_field(
+                    nested_model, nested_key, nested_field
+                ):
                     continue
                 metadata = settings_metadata(nested_field)
                 default_value = None

tests/sdk/test_settings.py

@@ -1,4 +1,3 @@
-import pytest
 from fastmcp.mcp_config import MCPConfig
 from pydantic import SecretStr
 
@@ -145,22 +144,14 @@ def test_conversation_settings_export_schema_groups_sections() -> None:
     assert verification_fields["security_analyzer"].depends_on == ["confirmation_mode"]
 
 
-def test_verification_settings_legacy_controls_remain_deprecated_accessors() -> None:
-    settings = VerificationSettings()
-
-    with pytest.deprecated_call():
-        assert settings.confirmation_mode is False
-    with pytest.deprecated_call():
-        settings.confirmation_mode = True
-    with pytest.deprecated_call():
-        assert settings.confirmation_mode is True
+def test_verification_settings_legacy_controls_are_excluded_from_dump() -> None:
+    settings = VerificationSettings(
+        confirmation_mode=True,
+        security_analyzer="llm",
+    )
 
-    with pytest.deprecated_call():
-        assert settings.security_analyzer is None
-    with pytest.deprecated_call():
-        settings.security_analyzer = "llm"
-    with pytest.deprecated_call():
-        assert settings.security_analyzer == "llm"
+    assert settings.confirmation_mode is True
+    assert settings.security_analyzer == "llm"
 
     dumped = settings.model_dump(mode="json")
     assert "confirmation_mode" not in dumped