Align relationship API with SDK redesign patterns

- Rename solution_unique_name parameter to solution (shorter, consistent)
- Add keyword-only separator (*) for optional parameters
- Update tests to use new parameter style

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Author: tpellissier

src/PowerPlatform/Dataverse/client.py

@@ -711,7 +711,8 @@ def create_one_to_many_relationship(
         self,
         lookup: LookupAttributeMetadata,
         relationship: OneToManyRelationshipMetadata,
-        solution_unique_name: Optional[str] = None,
+        *,
+        solution: Optional[str] = None,
     ) -> Dict[str, Any]:
         """
         Create a one-to-many relationship between tables.
@@ -723,8 +724,8 @@ def create_one_to_many_relationship(
         :type lookup: ~PowerPlatform.Dataverse.models.metadata.LookupAttributeMetadata
         :param relationship: Metadata defining the relationship.
         :type relationship: ~PowerPlatform.Dataverse.models.metadata.OneToManyRelationshipMetadata
-        :param solution_unique_name: Optional solution to add relationship to.
-        :type solution_unique_name: :class:`str` or None
+        :param solution: Optional solution unique name to add relationship to.
+        :type solution: :class:`str` or None
 
         :return: Dictionary with relationship_id, lookup_schema_name, and related metadata.
         :rtype: :class:`dict`
@@ -770,13 +771,14 @@ def create_one_to_many_relationship(
             return od._create_one_to_many_relationship(
                 lookup,
                 relationship,
-                solution_unique_name,
+                solution,
             )
 
     def create_many_to_many_relationship(
         self,
         relationship: ManyToManyRelationshipMetadata,
-        solution_unique_name: Optional[str] = None,
+        *,
+        solution: Optional[str] = None,
     ) -> Dict[str, Any]:
         """
         Create a many-to-many relationship between tables.
@@ -786,8 +788,8 @@ def create_many_to_many_relationship(
 
         :param relationship: Metadata defining the many-to-many relationship.
         :type relationship: ~PowerPlatform.Dataverse.models.metadata.ManyToManyRelationshipMetadata
-        :param solution_unique_name: Optional solution to add relationship to.
-        :type solution_unique_name: :class:`str` or None
+        :param solution: Optional solution unique name to add relationship to.
+        :type solution: :class:`str` or None
 
         :return: Dictionary with relationship_id, relationship_schema_name, and entity names.
         :rtype: :class:`dict`
@@ -814,7 +816,7 @@ def create_many_to_many_relationship(
         with self._scoped_odata() as od:
             return od._create_many_to_many_relationship(
                 relationship,
-                solution_unique_name,
+                solution,
             )
 
     def delete_relationship(self, relationship_id: str) -> None:
@@ -865,11 +867,12 @@ def create_lookup_field(
         referencing_table: str,
         lookup_field_name: str,
         referenced_table: str,
+        *,
         display_name: Optional[str] = None,
         description: Optional[str] = None,
         required: bool = False,
         cascade_delete: str = "RemoveLink",
-        solution_unique_name: Optional[str] = None,
+        solution: Optional[str] = None,
         language_code: int = 1033,
     ) -> Dict[str, Any]:
         """
@@ -893,8 +896,8 @@ def create_lookup_field(
         :param cascade_delete: Delete behavior (``"RemoveLink"``, ``"Cascade"``, ``"Restrict"``).
             Defaults to ``"RemoveLink"``.
         :type cascade_delete: :class:`str`
-        :param solution_unique_name: Optional solution to add the relationship to.
-        :type solution_unique_name: :class:`str` or None
+        :param solution: Optional solution unique name to add the relationship to.
+        :type solution: :class:`str` or None
         :param language_code: Language code for labels. Defaults to 1033 (English).
         :type language_code: :class:`int`
 
@@ -945,7 +948,7 @@ def create_lookup_field(
             cascade_configuration=CascadeConfiguration(delete=cascade_delete),
         )
 
-        return self.create_one_to_many_relationship(lookup, relationship, solution_unique_name)
+        return self.create_one_to_many_relationship(lookup, relationship, solution=solution)
 
 
 __all__ = ["DataverseClient"]

src/PowerPlatform/Dataverse/data/_relationships.py

@@ -27,7 +27,7 @@ def _create_one_to_many_relationship(
         self,
         lookup,
         relationship,
-        solution_unique_name: Optional[str] = None,
+        solution: Optional[str] = None,
     ) -> Dict[str, Any]:
         """
         Create a one-to-many relationship with lookup attribute.
@@ -38,8 +38,8 @@ def _create_one_to_many_relationship(
         :type lookup: ~PowerPlatform.Dataverse.models.metadata.LookupAttributeMetadata
         :param relationship: Relationship metadata (OneToManyRelationshipMetadata instance).
         :type relationship: ~PowerPlatform.Dataverse.models.metadata.OneToManyRelationshipMetadata
-        :param solution_unique_name: Optional solution to add the relationship to.
-        :type solution_unique_name: ``str`` | ``None``
+        :param solution: Optional solution unique name to add the relationship to.
+        :type solution: ``str`` | ``None``
 
         :return: Dictionary with relationship_id, attribute_id, and schema names.
         :rtype: ``dict[str, Any]``
@@ -53,8 +53,8 @@ def _create_one_to_many_relationship(
         payload["Lookup"] = lookup.to_dict()
 
         headers = self._headers().copy()
-        if solution_unique_name:
-            headers["MSCRM.SolutionUniqueName"] = solution_unique_name
+        if solution:
+            headers["MSCRM.SolutionUniqueName"] = solution
 
         r = self._request("post", url, headers=headers, json=payload)
 
@@ -72,7 +72,7 @@ def _create_one_to_many_relationship(
     def _create_many_to_many_relationship(
         self,
         relationship,
-        solution_unique_name: Optional[str] = None,
+        solution: Optional[str] = None,
     ) -> Dict[str, Any]:
         """
         Create a many-to-many relationship.
@@ -81,8 +81,8 @@ def _create_many_to_many_relationship(
 
         :param relationship: Relationship metadata (ManyToManyRelationshipMetadata instance).
         :type relationship: ~PowerPlatform.Dataverse.models.metadata.ManyToManyRelationshipMetadata
-        :param solution_unique_name: Optional solution to add the relationship to.
-        :type solution_unique_name: ``str`` | ``None``
+        :param solution: Optional solution unique name to add the relationship to.
+        :type solution: ``str`` | ``None``
 
         :return: Dictionary with relationship_id and schema name.
         :rtype: ``dict[str, Any]``
@@ -94,8 +94,8 @@ def _create_many_to_many_relationship(
         payload = relationship.to_dict()
 
         headers = self._headers().copy()
-        if solution_unique_name:
-            headers["MSCRM.SolutionUniqueName"] = solution_unique_name
+        if solution:
+            headers["MSCRM.SolutionUniqueName"] = solution
 
         r = self._request("post", url, headers=headers, json=payload)
 

tests/unit/data/test_relationships.py

@@ -131,7 +131,7 @@ def test_create_relationship_with_solution(self):
         }
         self.client._mock_request.return_value = mock_response
 
-        self.client._create_one_to_many_relationship(self.lookup, self.relationship, solution_unique_name="MySolution")
+        self.client._create_one_to_many_relationship(self.lookup, self.relationship, solution="MySolution")
 
         # Verify solution header
         call_args = self.client._mock_request.call_args

tests/unit/test_client.py

@@ -164,7 +164,7 @@ def test_basic_lookup_field_creation(self):
         call_args = self.client.create_one_to_many_relationship.call_args
         lookup = call_args[0][0]
         relationship = call_args[0][1]
-        solution = call_args[0][2]
+        solution = call_args.kwargs.get("solution")
 
         # Verify lookup metadata
         self.assertEqual(lookup.schema_name, "new_AccountId")
@@ -175,7 +175,7 @@ def test_basic_lookup_field_creation(self):
         self.assertEqual(relationship.referencing_entity, "new_order")
         self.assertEqual(relationship.referenced_attribute, "accountid")
 
-        # Verify no solution
+        # Verify no solution (keyword-only, defaults to None)
         self.assertIsNone(solution)
 
     def test_lookup_with_display_name(self):
@@ -269,17 +269,17 @@ def test_cascade_delete_configuration(self):
         cascade_dict = relationship.cascade_configuration.to_dict()
         self.assertEqual(cascade_dict["Delete"], "Cascade")
 
-    def test_solution_unique_name_passed(self):
-        """Test that solution_unique_name is passed through."""
+    def test_solution_passed(self):
+        """Test that solution is passed through."""
         self.client.create_lookup_field(
             referencing_table="new_order",
             lookup_field_name="new_AccountId",
             referenced_table="account",
-            solution_unique_name="MySolution",
+            solution="MySolution",
         )
 
         call_args = self.client.create_one_to_many_relationship.call_args
-        solution = call_args[0][2]
+        solution = call_args.kwargs.get("solution")
 
         self.assertEqual(solution, "MySolution")