[feat] Added support include_relationship_attributes support to fluent search

Author: Aryamanz29

pyatlan/model/assets/relations/user_def_relationship.py

@@ -24,12 +24,10 @@ class UserDefRelationship(RelationshipAttributes):
     class Attributes(AtlanObject):
         from_type_label: Optional[str] = Field(
             default=None,
-            alias="fromTypeLabel",
             description="Name for the relationship when referring from endDef2 asset to endDef1 asset.",
         )
         to_type_label: Optional[str] = Field(
             default=None,
-            alias="toTypeLabel",
             description="Name for the relationship when referring from endDef1 asset to endDef2 asset.",
         )
 
@@ -46,7 +44,6 @@ class UserDefRelationshipFrom(Asset):
         )
         relationship_type: str = Field(
             default="UserDefRelationship",
-            const=True,
             description="Fixed typeName for UserDefRelationship.",
         )
         relationship_attributes: UserDefRelationship = Field(

pyatlan/model/fluent_search.py

@@ -381,13 +381,15 @@ def __init__(
         _page_size: Optional[int] = None,
         _includes_on_results: Optional[List[str]] = None,
         _includes_on_relations: Optional[List[str]] = None,
+        _include_relationship_attributes: Optional[bool] = False,
     ):
         super().__init__(wheres, where_nots, where_somes, _min_somes)
         self.sorts = sorts
         self.aggregations = aggregations
         self._page_size = _page_size
         self._includes_on_results = _includes_on_results
         self._includes_on_relations = _includes_on_relations
+        self._include_relationship_attributes = _include_relationship_attributes
 
     def _clone(self) -> "FluentSearch":
         """
@@ -468,6 +470,22 @@ def include_on_relations(self, field: Union[str, AtlanField]) -> "FluentSearch":
             clone._includes_on_relations.append(field)
         return clone
 
+    def include_relationship_attributes(self, include: bool) -> "FluentSearch":
+        """
+        Add an attribute to include relationship attributes on each relationship in the results.
+
+        :param include: include relationship attributes on each relationship in the results
+        :returns: the fluent search with this parameter added
+        """
+        clone = self._clone()
+        # When enabling `include_relationship_attributes`
+        # it's mandatory to include the "name" field
+        # to ensure relationship names are included in the response.
+        # Omitting "name" will result in a 500 error from the metastore.
+        clone = self.include_on_relations("name")
+        clone._include_relationship_attributes = include
+        return clone
+
     def _dsl(self) -> DSL:
         """
         Translate the Atlan fluent search into an Atlan search DSL.
@@ -495,6 +513,10 @@ def to_request(self) -> IndexSearchRequest:
             request.attributes = self._includes_on_results
         if self._includes_on_relations:
             request.relation_attributes = self._includes_on_relations
+        if self._include_relationship_attributes:
+            request.include_relationship_attributes = (
+                self._include_relationship_attributes
+            )
         return request
 
     def count(self, client: AtlanClient) -> int:

pyatlan/model/search.py

@@ -2024,6 +2024,16 @@ class IndexSearchRequest(SearchRequest):
         default=None,
         description="Qualified name of the purpose eg: default/zL6uqsrZGuf1hz9XFYnw9x",
     )
+    include_relationship_attributes: Optional[bool] = Field(
+        default=False,
+        alias="includeRelationshipAttributes",
+        description=(
+            "Whether to include relationship-level attributes "
+            "for any relationships to each asset (True) or not (False). "
+            "By default, this is `False` and therefore "
+            "relationship-level attributes are not included."
+        ),
+    )
     request_metadata: Optional[IndexSearchRequestMetadata] = Field(
         default_factory=lambda: IndexSearchRequestMetadata(
             # Set this to `False` to prevent the frequent