semantic markup update

backend/src/plugins/debug.py

@@ -20,25 +20,57 @@ class DebugPlugin(PluginBase):
     """
 
     @property
+    # [DEF:id:Function]
+    # @PURPOSE: Returns the unique identifier for the debug plugin.
+    # @PRE: Plugin instance exists.
+    # @POST: Returns string ID.
+    # @RETURN: str - "system-debug"
     def id(self) -> str:
-        return "system-debug"
+        with belief_scope("id"):
+            return "system-debug"
+    # [/DEF:id:Function]
 
     @property
+    # [DEF:name:Function]
+    # @PURPOSE: Returns the human-readable name of the debug plugin.
+    # @PRE: Plugin instance exists.
+    # @POST: Returns string name.
+    # @RETURN: str - Plugin name.
     def name(self) -> str:
-        return "System Debug"
+        with belief_scope("name"):
+            return "System Debug"
+    # [/DEF:name:Function]
 
     @property
+    # [DEF:description:Function]
+    # @PURPOSE: Returns a description of the debug plugin.
+    # @PRE: Plugin instance exists.
+    # @POST: Returns string description.
+    # @RETURN: str - Plugin description.
     def description(self) -> str:
-        return "Run system diagnostics and debug Superset API responses."
+        with belief_scope("description"):
+            return "Run system diagnostics and debug Superset API responses."
+    # [/DEF:description:Function]
 
     @property
+    # [DEF:version:Function]
+    # @PURPOSE: Returns the version of the debug plugin.
+    # @PRE: Plugin instance exists.
+    # @POST: Returns string version.
+    # @RETURN: str - "1.0.0"
     def version(self) -> str:
-        return "1.0.0"
+        with belief_scope("version"):
+            return "1.0.0"
+    # [/DEF:version:Function]
 
-    # [DEF:DebugPlugin.get_schema:Function]
+    # [DEF:get_schema:Function]
     # @PURPOSE: Returns the JSON schema for the debug plugin parameters.
+    # @PRE: Plugin instance exists.
+    # @POST: Returns dictionary schema.
+    # @RETURN: Dict[str, Any] - JSON schema.
     def get_schema(self) -> Dict[str, Any]:
-        return {
+        with belief_scope("get_schema"):
+            return {
             "type": "object",
             "properties": {
                 "action": {
@@ -70,12 +102,16 @@ class DebugPlugin(PluginBase):
             },
             "required": ["action"]
         }
-    # [/DEF:DebugPlugin.get_schema:Function]
+    # [/DEF:get_schema:Function]
 
-    # [DEF:DebugPlugin.execute:Function]
+    # [DEF:execute:Function]
     # @PURPOSE: Executes the debug logic.
+    # @PARAM: params (Dict[str, Any]) - Debug parameters.
+    # @PRE: action must be provided in params.
+    # @POST: Debug action is executed and results returned.
+    # @RETURN: Dict[str, Any] - Execution results.
     async def execute(self, params: Dict[str, Any]) -> Dict[str, Any]:
-        with belief_scope("DebugPlugin.execute", f"params={params}"):
+        with belief_scope("execute"):
             action = params.get("action")
             
             if action == "test-db-api":
@@ -84,16 +120,17 @@ class DebugPlugin(PluginBase):
                 return await self._get_dataset_structure(params)
             else:
                 raise ValueError(f"Unknown action: {action}")
-    # [/DEF:DebugPlugin.execute:Function]
+    # [/DEF:execute:Function]
 
-    # [DEF:DebugPlugin._test_db_api:Function]
+    # [DEF:_test_db_api:Function]
     # @PURPOSE: Tests database API connectivity for source and target environments.
-    # @PRE:     source_env and target_env params exist.
+    # @PRE:     source_env and target_env params exist in params.
     # @POST:    Returns DB counts for both envs.
     # @PARAM:   params (Dict) - Plugin parameters.
     # @RETURN:  Dict - Comparison results.
     async def _test_db_api(self, params: Dict[str, Any]) -> Dict[str, Any]:
-        source_env_name = params.get("source_env")
+        with belief_scope("_test_db_api"):
+            source_env_name = params.get("source_env")
         target_env_name = params.get("target_env")
         
         if not source_env_name or not target_env_name:
@@ -117,16 +154,17 @@ class DebugPlugin(PluginBase):
             }
             
         return results
-    # [/DEF:DebugPlugin._test_db_api:Function]
+    # [/DEF:_test_db_api:Function]
 
-    # [DEF:DebugPlugin._get_dataset_structure:Function]
+    # [DEF:_get_dataset_structure:Function]
     # @PURPOSE: Retrieves the structure of a dataset.
-    # @PRE:     env and dataset_id params exist.
+    # @PRE:     env and dataset_id params exist in params.
     # @POST:    Returns dataset JSON structure.
     # @PARAM:   params (Dict) - Plugin parameters.
     # @RETURN:  Dict - Dataset structure.
     async def _get_dataset_structure(self, params: Dict[str, Any]) -> Dict[str, Any]:
-        env_name = params.get("env")
+        with belief_scope("_get_dataset_structure"):
+            env_name = params.get("env")
         dataset_id = params.get("dataset_id")
         
         if not env_name or dataset_id is None:
@@ -143,7 +181,7 @@ class DebugPlugin(PluginBase):
         
         dataset_response = client.get_dataset(dataset_id)
         return dataset_response.get('result') or {}
-    # [/DEF:DebugPlugin._get_dataset_structure:Function]
+    # [/DEF:_get_dataset_structure:Function]
 
 # [/DEF:DebugPlugin:Class]
 # [/DEF:DebugPluginModule:Module]