fix(identity): Remove docstring required, optional keywords(#31)

Author: S0okJu

src/openstack_mcp_server/tools/identity_tools.py

@@ -46,7 +46,7 @@ def get_region(self, id: str) -> Region:
         """
         Get a region.
 
-        :param id: The ID of the region. (required)
+        :param id: The ID of the region.
 
         :return: The Region object.
         """
@@ -56,12 +56,12 @@ def get_region(self, id: str) -> Region:
 
         return Region(id=region.id, description=region.description)
 
-    def create_region(self, id: str, description: str = "") -> Region:
+    def create_region(self, id: str, description: str | None= None) -> Region:
         """
         Create a new region.
 
-        :param id: The ID of the region. (required)
-        :param description: The description of the region. (optional)
+        :param id: The ID of the region.
+        :param description: The description of the region. 
 
         :return: The created Region object.
         """
@@ -75,7 +75,7 @@ def delete_region(self, id: str) -> None:
         """
         Delete a region.
 
-        :param id: The ID of the region. (required)
+        :param id: The ID of the region.
 
         :return: None
         """
@@ -86,12 +86,12 @@ def delete_region(self, id: str) -> None:
 
         return None
 
-    def update_region(self, id: str, description: str = "") -> Region:
+    def update_region(self, id: str, description: str | None = None) -> Region:
         """
         Update a region.
 
-        :param id: The ID of the region. (required)
-        :param description: The string description of the region. (optional)
+        :param id: The ID of the region.
+        :param description: The string description of the region.
 
         :return: The updated Region object.
         """
@@ -131,7 +131,7 @@ def get_domain(self, name: str) -> Domain:
         """
         Get a domain.
 
-        :param name: The name of the domain. (required)
+        :param name: The name of the domain.
 
         :return: The Domain object.
         """
@@ -149,15 +149,15 @@ def get_domain(self, name: str) -> Domain:
     def create_domain(
         self,
         name: str,
-        description: str = "",
-        is_enabled: bool = False,
+        description: str | None = None,
+        is_enabled: bool  | None = False,
     ) -> Domain:
         """
         Create a new domain.
 
-        :param name: The name of the domain. (required)
-        :param description: The description of the domain. (optional)
-        :param is_enabled: Whether the domain is enabled. (optional)
+        :param name: The name of the domain.
+        :param description: The description of the domain.
+        :param is_enabled: Whether the domain is enabled.
         """
         conn = get_openstack_conn()
 
@@ -178,7 +178,7 @@ def delete_domain(self, name: str) -> None:
         """
         Delete a domain.
 
-        :param name: The name of the domain. (required)
+        :param name: The name of the domain.
         """
         conn = get_openstack_conn()
 
@@ -197,10 +197,10 @@ def update_domain(
         """
         Update a domain.
 
-        :param id: The ID of the domain. (required)
-        :param name: The name of the domain. (optional)
-        :param description: The description of the domain. (optional)
-        :param is_enabled: Whether the domain is enabled. (optional)
+        :param id: The ID of the domain.
+        :param name: The name of the domain.
+        :param description: The description of the domain.
+        :param is_enabled: Whether the domain is enabled.
         """
         conn = get_openstack_conn()
 

src/openstack_mcp_server/tools/response/identity.py

@@ -5,11 +5,11 @@
 # In this case, we are only using description field as optional.
 class Region(BaseModel):
     id: str
-    description: str = ""
+    description: str | None = None
 
 
 class Domain(BaseModel):
     id: str
     name: str
-    description: str = ""
-    is_enabled: bool = False
+    description: str | None = None
+    is_enabled: bool | None = None

tests/tools/test_identity_tools.py

@@ -103,7 +103,7 @@ def test_create_region_without_description(
         # Create mock region object
         mock_region = Mock()
         mock_region.id = "RegionOne"
-        mock_region.description = ""
+        mock_region.description = None
 
         # Configure mock region.create_region()
         mock_conn.identity.create_region.return_value = mock_region
@@ -233,7 +233,7 @@ def test_update_region_without_description(
         # Create mock region object
         mock_region = Mock()
         mock_region.id = "RegionOne"
-        mock_region.description = ""
+        mock_region.description = None
 
         # Configure mock region.update_region()
         mock_conn.identity.update_region.return_value = mock_region
@@ -248,7 +248,7 @@ def test_update_region_without_description(
         # Verify mock calls
         mock_conn.identity.update_region.assert_called_once_with(
             region="RegionOne",
-            description="",
+            description=None,
         )
 
     def test_update_region_invalid_id_format(
@@ -519,7 +519,7 @@ def test_create_domain_without_description(
         mock_domain = Mock()
         mock_domain.id = "d01a81393377480cbd75c0210442e687"
         mock_domain.name = "domainone"
-        mock_domain.description = ""
+        mock_domain.description = None
         mock_domain.is_enabled = False
 
         # Configure mock domain.create_domain()
@@ -533,14 +533,14 @@ def test_create_domain_without_description(
         assert result == Domain(
             id="d01a81393377480cbd75c0210442e687",
             name="domainone",
-            description="",
+            description=None,
             is_enabled=False,
         )
 
         # Verify mock calls
         mock_conn.identity.create_domain.assert_called_once_with(
             name="domainone",
-            description="",
+            description=None,
             enabled=False,
         )