fix: deprecate unused config in powerbi-report-server source

The source use graph from ctx so graphql_url is not needed.
datahub-project · Dec 4, 2022 · a7522da · a7522da
1 parent 4876fdd
commit a7522da
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/how/updating-datahub.md b/docs/how/updating-datahub.md
@@ -6,6 +6,8 @@ This file documents any backwards-incompatible changes in DataHub and assists pe
 
 ### Breaking Changes
 
+- `graphql_url` option of `powerbi-report-server` source deprecated as the options is not used.
+
 ### Potential Downtime
 
 ### Deprecations

diff --git a/metadata-ingestion/docs/sources/powerbi/powerbi-report-server_recipe.yml b/metadata-ingestion/docs/sources/powerbi/powerbi-report-server_recipe.yml
@@ -13,8 +13,6 @@ source:
     server_alias: server_alias
     # Workspace's dataset environments, example: (PROD, DEV, QA, STAGE)
     env: DEV
-    # Workspace's dataset environments, example: (PROD, DEV, QA, STAGE)
-    graphql_url: http://localhost:8080/api/graphql
     # Your Power BI Report Server base virtual directory name for reports
     report_virtual_directory_name: Reports
     #  Your Power BI Report Server base virtual directory name for report server

diff --git a/metadata-ingestion/src/datahub/ingestion/source/powerbi_report_server/report_server.py b/metadata-ingestion/src/datahub/ingestion/source/powerbi_report_server/report_server.py
@@ -5,7 +5,7 @@
 #########################################################
 import logging
 from dataclasses import dataclass, field as dataclass_field
-from typing import Any, Dict, Iterable, List
+from typing import Any, Dict, Iterable, List, Optional
 
 import pydantic
 import requests
@@ -68,7 +68,7 @@ class PowerBiReportServerAPIConfig(EnvBasedSourceConfigBase):
     server_alias: str = pydantic.Field(
         default="", description="Alias for Power BI Report Server host URL"
     )
-    graphql_url: str = pydantic.Field(description="GraphQL API URL")
+    graphql_url: Optional[str] = pydantic.Field(default=None, description="[deprecated] Not used")
     report_virtual_directory_name: str = pydantic.Field(
         description="Report Virtual Directory URL name"
     )

diff --git a/metadata-ingestion/tests/integration/powerbi_report_server/test_powerbi_report_server.py b/metadata-ingestion/tests/integration/powerbi_report_server/test_powerbi_report_server.py
@@ -167,7 +167,7 @@ def default_source_config():
         "workstation_name": "workstation",
         "host_port": "host_port",
         "server_alias": "server_alias",
-        "graphql_url": "http://localhost:8080/api/graphql",
+        "graphql_url": None,
         "report_virtual_directory_name": "Reports",
         "report_server_virtual_directory_name": "ReportServer",
         "env": "DEV",