pyegeria 5.2.0.20__py3-none-any.whl → 5.2.0.42.2__py3-none-any.whl

pyegeria/commands/tech/list_relationship_types.py

@@ -14,6 +14,7 @@ import time
 from rich import box
 from rich import print
 from rich.console import Console
+from rich.markdown import Markdown
 from rich.prompt import Prompt
 from rich.table import Table
 
@@ -32,7 +33,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
@@ -69,16 +70,11 @@ def display_relationship_types(
             expand=True,
         )
 
-        table.add_column("Status")
         table.add_column("Name")
-        # table.add_column("GUID", no_wrap=True,)
-
+        table.add_column("Status")
         table.add_column("Description")
-        table.add_column("Attrib Name")
-        table.add_column("Attrib Status")
-        table.add_column("Attrib Type")
-        table.add_column("Attrib Description")
         table.add_column("Description Wiki", no_wrap=True)
+        table.add_column("Attributes", min_width=50)
 
         types_list = p_client.get_valid_relationship_types(type_name)
 
@@ -99,27 +95,27 @@ def display_relationship_types(
                 description = types["description"]
                 description_wiki = types.get("descriptionWiki", " ")
                 attribute_defs = types.get("attributeDefinitions")
+
+                att_table = Table(show_lines=True)
+                att_table.add_column("Name")
+                att_table.add_column("Description")
+                att_table.add_column("Status")
+                att_table.add_column("Type")
+
                 if attribute_defs:
+                    att_md = True
                     for attr in attribute_defs:
                         attr_name = attr["attributeName"]
                         attr_desc = attr["attributeDescription"]
                         attr_status = attr["attributeStatus"]
                         attr_type = attr["attributeType"]["name"]
-                        table.add_row(
-                            status,
-                            name,
-                            description,
-                            attr_name,
-                            attr_status,
-                            attr_type,
-                            attr_desc,
-                            description_wiki,
-                        )
+                        att_table.add_row(attr_name, attr_desc, attr_status, attr_type)
+
                 else:
-                    table.add_row(
-                        status, name, description, description_wiki, " ", " ", " ", " "
-                    )
+                    att_md = False
+            att_out = att_table if att_md else " "
 
+            table.add_row(name, status, description, description_wiki, att_out)
         p_client.close_session()
         return table
 
@@ -157,7 +153,9 @@ def main():
     userid = args.userid if args.userid is not None else EGERIA_USER
     user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
     save_output = args.save_output if args.save_output is not None else False
-    type_name = Prompt.ask("Enter the Type Name to retrieve:", default="AssetOwner")
+    type_name = Prompt.ask(
+        "Enter the OM Type Name to retrieve relationships for:", default="AssetOwner"
+    )
 
     display_relationship_types(type_name, server, url, userid, user_pass, save_output)
 

pyegeria/commands/tech/list_relationships.py

@@ -16,6 +16,7 @@ import time
 from rich import box
 from rich.console import Console
 from rich.markdown import Markdown
+from rich.prompt import Prompt
 from rich.table import Table
 
 from pyegeria import (
@@ -23,6 +24,7 @@ from pyegeria import (
     PropertyServerException,
     UserNotAuthorizedException,
     ClassificationManager,
+    max_paging_size,
 )
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -32,7 +34,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
@@ -87,7 +89,7 @@ def list_relationships(
         table.add_column("Properties", min_width=40)
 
         rel_list = g_client.get_relationships(
-            search_string, page_size=100, time_out=time_out
+            search_string, page_size=max_paging_size, time_out=time_out
         )
         if type(rel_list) is str:
             return table
@@ -164,8 +166,10 @@ def main():
     user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
     time_out = args.time_out if args.time_out is not None else 60
     try:
-        # search_string = Prompt.ask("Enter an asset search string:", default="*")
-        search_string = "Certification"
+        search_string = Prompt.ask(
+            "Enter an asset search string:", default="Certification"
+        )
+
         list_relationships(search_string, server, url, userid, user_pass, time_out)
     except KeyboardInterrupt:
         pass

pyegeria/commands/tech/list_tech_templates.py

@@ -29,7 +29,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")

pyegeria/commands/tech/list_valid_metadata_values.py

@@ -35,7 +35,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")

pyegeria/commands/tech/table_tech_templates.py

@@ -31,7 +31,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")

pyegeria/commands/tech/x_list_related_elements.py

@@ -34,7 +34,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")

pyegeria/create_tech_guid_lists.py

@@ -82,10 +82,10 @@ def build_global_guid_lists(
                     )
             #
             #   Ok - now lets harvest integration connectors using get_integration_daemon_status from ServerOps
-            #   Assume that integration daemon called integration-daemon
+            #   Assume that integration daemon called integration_daemon
             #
             s_client = ServerOps(
-                "integration-daemon", url, user_id=user_id, user_pwd=user_pwd
+                "integration_daemon", url, user_id=user_id, user_pwd=user_pwd
             )
             integ_status = s_client.get_integration_daemon_status()
 

pyegeria/glossary_manager_omvs.py

@@ -2470,7 +2470,70 @@ class GlossaryManager(GlossaryBrowser):
             )
         )
 
-        return
+    async def _async_undo_term_update(self, glossary_term_guid: str) -> None:
+        """Undo an update to a glossary term
+
+            Async Version.
+
+        Parameters
+        ----------
+            glossary_term_guid: str
+                Unique identifier for the source glossary term.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+         InvalidParameterException
+             If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
+         PropertyServerException
+             Raised by the server when an issue arises in processing a valid request.
+         NotAuthorizedException
+             The principle specified by the user_id does not have authorization for the requested action.
+        Notes
+        -----
+        This creates a new version with the state of the term before the last update.
+
+        """
+
+        validate_guid(glossary_term_guid)
+
+        url = (
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-manager/glossaries/terms/"
+            f"{glossary_term_guid}/undo"
+        )
+
+        await self._async_make_request("POST", url)
+
+    def undo_term_update(self, glossary_term_guid: str) -> None:
+        """Undo an update to a glossary term
+
+        Parameters
+        ----------
+            glossary_term_guid: str
+                Unique identifier for the source glossary term.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+         InvalidParameterException
+             If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
+         PropertyServerException
+             Raised by the server when an issue arises in processing a valid request.
+         NotAuthorizedException
+             The principle specified by the user_id does not have authorization for the requested action.
+        Notes
+        -----
+        This creates a new version with the state of the term before the last update.
+
+        """
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(self._async_undo_term_update(glossary_term_guid))
 
     async def _async_get_terms_for_category(
         self,

pyegeria/mermaid_utilities.py

@@ -33,7 +33,7 @@ EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
 EGERIA_VIEW_SERVER_URL = os.environ.get(
     "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
 )
-EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration_daemon")
 EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
 EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
 EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")

pyegeria/metadata_explorer_omvs.py

@@ -17,6 +17,8 @@ from pyegeria import body_slimmer
 from pyegeria._client import Client, max_paging_size
 from pyegeria._globals import default_time_out
 
+NO_ELEMENTS_FOUND = "No_elements_found"
+
 
 def query_seperator(current_string):
     if current_string == "":
@@ -40,26 +42,38 @@ def base_path(client, view_server: str):
     return f"{client.platform_url}/servers/{view_server}/api/open-metadata/metadata-explorer"
 
 
-def process_related_element_list(response: Response, mermaid_only: bool) -> str | dict:
+def process_related_element_list(
+    response: Response, mermaid_only: bool, relationship_list: bool = False
+) -> str | dict:
     """Process the result payload
 
     Parameters
     ----------
-    response
-    mermaid_only
+    response: Response
+        - the response payload from the API call
+    mermaid_only: bool
+        - if true, only return the Mermaid graph
+    relationship_list: bool
+        - if True, look for "relationshipList" otherwise look for "relatedElementList"
 
     Returns
     -------
 
     """
-    elements = response.json().get("relatedElementList", "No elements found")
+    if relationship_list:
+        elements = response.json().get("relationshipList", "No relationship list found")
+    else:
+        elements = response.json().get("relatedElementList", NO_ELEMENTS_FOUND)
+
     if isinstance(elements, str):
-        return "No elements found"
-    el_list = elements.get("elementList", "No elements found")
-    if isinstance(el_list, str):
-        return el_list
+        return NO_ELEMENTS_FOUND
     if mermaid_only:
         return elements.get("mermaidGraph", "No mermaid graph found")
+
+    el_list = elements.get("elementList", NO_ELEMENTS_FOUND)
+    if isinstance(el_list, str):
+        return el_list
+
     if len(el_list) == 0:
         return "No elements returned"
     return elements
@@ -174,7 +188,7 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body)
         )
-        return response.json().get("guid", "No elements found")
+        return response.json().get("guid", NO_ELEMENTS_FOUND)
 
     def get_metadata_guid_by_unique_name(
         self,
@@ -288,7 +302,7 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body)
         )
-        return response.json().get("element", "No elements found")
+        return response.json().get("element", NO_ELEMENTS_FOUND)
 
     def get_metadata_element_by_guid(
         self,
@@ -403,13 +417,13 @@ class MetadataExplorer(Client):
         )
         # if mermaid_only:
         #     return response.json()["elementGraph"].get(
-        #         "mermaidGraph", "No elements found"
+        #         "mermaidGraph", NO_ELEMENTS_FOUND
         #     )
         # else:
-        #     return response.json().get("elementGraph", "No elements found")
+        #     return response.json().get("elementGraph", NO_ELEMENTS_FOUND)
         if isinstance(response, str):
-            return "No elements found"
-        el_list = response.json().get("elementGraph", "No elements found")
+            return NO_ELEMENTS_FOUND
+        el_list = response.json().get("elementGraph", NO_ELEMENTS_FOUND)
         if isinstance(el_list, str):
             return el_list
         if mermaid_only:
@@ -517,7 +531,7 @@ class MetadataExplorer(Client):
     #     response = self.get_metadata_element_graph(
     #         guid, effective_time, as_of_time, for_lineage, for_duplicate_processing
     #     )
-    #     return response.get("mermaidGraph", "No elements found")
+    #     return response.get("mermaidGraph", NO_ELEMENTS_FOUND)
 
     async def _async_get_metadata_element_by_unique_name(
         self,
@@ -580,7 +594,7 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body)
         )
-        return response.json().get("element", "No elements found")
+        return response.json().get("element", NO_ELEMENTS_FOUND)
 
     def get_metadata_element_by_unique_name(
         self,
@@ -647,6 +661,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve all the versions of a metadata element. Async version.
@@ -676,7 +691,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -714,10 +731,10 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elementList", "No elements found")
+        elements = response.json().get("elementList", NO_ELEMENTS_FOUND)
         if type(elements) is list:
             if len(elements) == 0:
-                return "No elements found"
+                return NO_ELEMENTS_FOUND
         return elements
 
     def get_metadata_element_history(
@@ -732,6 +749,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """
         Retrieve all the versions of a metadata element.
@@ -761,7 +779,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -786,6 +806,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response
@@ -866,10 +887,10 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elementList", "No elements found")
+        elements = response.json().get("elementList", NO_ELEMENTS_FOUND)
         if type(elements) is list:
             if len(elements) == 0:
-                return "No elements found"
+                return NO_ELEMENTS_FOUND
         return elements
 
     def find_metadata_elements_with_string(
@@ -983,8 +1004,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
-
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
         Raises
         ------
         InvalidParameterException
@@ -1068,7 +1090,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1151,7 +1175,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1239,7 +1265,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1324,7 +1352,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1413,7 +1443,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1500,7 +1532,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1593,7 +1627,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1750,10 +1786,10 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elementList", "No elements found")
+        elements = response.json().get("elementList", NO_ELEMENTS_FOUND)
         if type(elements) is list:
             if len(elements) == 0:
-                return "No elements found"
+                return NO_ELEMENTS_FOUND
         return elements
 
     def find_metadata_elements(
@@ -1874,6 +1910,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """Return a list of relationships that match the requested conditions.
             The results can be received as a series of pages. Async version.
@@ -1892,11 +1929,15 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -1959,11 +2000,9 @@ class MetadataExplorer(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("relationshipList", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
-        return elements
+        return process_related_element_list(
+            response, mermaid_only, relationship_list=True
+        )
 
     def find_relationships_between_elements(
         self,
@@ -1973,6 +2012,7 @@ class MetadataExplorer(Client):
         start_from: int = 0,
         page_size: int = max_paging_size,
         time_out: int = default_time_out,
+        mermaid_only: bool = False,
     ) -> list | str:
         """Return a list of relationships that match the requested conditions.
             The results can be received as a series of pages.
@@ -1991,11 +2031,15 @@ class MetadataExplorer(Client):
             - maximum number of elements to return.
         time_out: int, default = default_time_out
             - http request timeout for this request
+        mermaid_only: bool, default is False
+            - if true only a string representing the mermaid graph will be returned
 
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -2049,6 +2093,7 @@ class MetadataExplorer(Client):
                 start_from,
                 page_size,
                 time_out,
+                mermaid_only,
             )
         )
         return response
@@ -2110,7 +2155,7 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body)
         )
-        return response.json().get("element", "No elements found")
+        return response.json().get("element", NO_ELEMENTS_FOUND)
 
     def get_relationship_by_guid(
         self,
@@ -2200,7 +2245,9 @@ class MetadataExplorer(Client):
         Returns
         -------
         [dict] | str
-            Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
         Raises
         ------
@@ -2237,9 +2284,9 @@ class MetadataExplorer(Client):
         response: Response = await self._async_make_request(
             "POST", url, body_slimmer(body), time_out=time_out
         )
-        rel = response.json().get("relationshipList", "No elements found")
+        rel = response.json().get("relationshipList", NO_ELEMENTS_FOUND)
         if isinstance(rel, (list, dict)):
-            return rel.get("elementList", "No elements found")
+            return rel.get("elementList", NO_ELEMENTS_FOUND)
         else:
             return rel
 
@@ -2287,7 +2334,9 @@ class MetadataExplorer(Client):
          Returns
          -------
          [dict] | str
-             Returns a string if no elements found and a list of dict of elements with the results.
+            If the element is found, and mermaid_only is False, a [dict] of the element details is returned.
+            If mermaid_only is True, a string representing the mermaid graph will be returned.
+            If no elements found, string "No element found".
 
          Raises
          ------