[Feature] Deprecate etf.holdings_performance endpoint (#6441)

* ignore the env created on the dev container (which lives inside the project folder)

* broken urls

* remove endpoint

* empty file

* deprecate

* ruff

.gitignore

@@ -52,3 +52,6 @@ cli/openbb_cli/assets/styles/user/hub.richstyle.json
 
 # Platform
 openbb_platform/openbb/package/*
+
+# Dev Container env
+obb/*

cli/README.md

@@ -14,7 +14,7 @@ The OpenBB Platform CLI is a command line interface that wraps [OpenBB Platform]
 
 It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts.
 
-Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://my.openbb.co/app/cli).
+Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://docs.openbb.co/cli).
 
 ## Installation
 
@@ -24,7 +24,7 @@ The command below provides access to the all the available OpenBB extensions beh
 pip install openbb-cli
 ```
 
-> Note: Find the most complete installation hints and tips [here](https://my.openbb.co/app/cli/installation).
+> Note: Find the most complete installation hints and tips [here](https://docs.openbb.co/cli/installation).
 
 After the installation is complete, you can deploy the OpenBB Platform CLI by running the following command:
 

openbb_platform/core/tests/app/test_deprecation.py

@@ -2,17 +2,13 @@
 
 import unittest
 
-import pytest
 from openbb_core.app.static.package_builder import PathHandler
 from openbb_core.app.version import VERSION, get_major_minor
 
 
 class DeprecatedCommandsTest(unittest.TestCase):
     """Test deprecated commands."""
 
-    @pytest.mark.skip(
-        "We forgot to deprecate /etf/holdings_performance. Check this endpoint next release."
-    )
     def test_deprecated_commands(self):
         """Test deprecated commands."""
         current_major_minor = get_major_minor(VERSION)

openbb_platform/extensions/etf/integration/test_etf_api.py

@@ -463,25 +463,6 @@ def test_etf_discovery_active(params, headers):
     assert result.status_code == 200
 
 
-@parametrize(
-    "params",
-    [
-        ({"symbol": "SPY", "provider": "fmp"}),
-        ({"symbol": "QQQ", "provider": "fmp"}),
-    ],
-)
-@pytest.mark.integration
-def test_etf_holdings_performance(params, headers):
-    """Test the ETF holdings performance endpoint."""
-    params = {p: v for p, v in params.items() if v}
-
-    query_str = get_querystring(params, [])
-    url = f"http://0.0.0.0:8000/api/v1/etf/holdings_performance?{query_str}"
-    result = requests.get(url, headers=headers, timeout=10)
-    assert isinstance(result, requests.Response)
-    assert result.status_code == 200
-
-
 @parametrize(
     "params",
     [

openbb_platform/extensions/etf/integration/test_etf_python.py

@@ -446,24 +446,6 @@ def test_etf_discovery_active(params, obb):
     assert len(result.results) > 0
 
 
-@parametrize(
-    "params",
-    [
-        ({"symbol": "SPY", "provider": "fmp"}),
-        ({"symbol": "QQQ", "provider": "fmp"}),
-    ],
-)
-@pytest.mark.integration
-def test_etf_holdings_performance(params, obb):
-    """Test the ETF holdings performance endpoint."""
-    params = {p: v for p, v in params.items() if v}
-
-    result = obb.etf.holdings_performance(**params)
-    assert result
-    assert isinstance(result, OBBject)
-    assert len(result.results) > 0
-
-
 @parametrize(
     "params",
     [

openbb_platform/extensions/etf/openbb_etf/etf_router.py

@@ -1,6 +1,5 @@
 """ETF Router."""
 
-from openbb_core.app.deprecation import OpenBBDeprecationWarning
 from openbb_core.app.model.command_context import CommandContext
 from openbb_core.app.model.example import APIEx
 from openbb_core.app.model.obbject import OBBject
@@ -171,27 +170,6 @@ async def holdings_date(
     return await OBBject.from_query(Query(**locals()))
 
 
-@router.command(
-    model="EtfHoldingsPerformance",
-    deprecated=True,
-    deprecation=OpenBBDeprecationWarning(
-        message="This endpoint is deprecated; pass a list of holdings symbols directly to"
-        + " `/equity/price/performance` instead.",
-        since=(4, 1),
-        expected_removal=(4, 2),
-    ),
-    examples=[APIEx(parameters={"symbol": "XLK", "provider": "fmp"})],
-)
-async def holdings_performance(
-    cc: CommandContext,
-    provider_choices: ProviderChoices,
-    standard_params: StandardParams,
-    extra_params: ExtraParams,
-) -> OBBject:
-    """Get the recent price performance of each ticker held in the ETF."""
-    return await OBBject.from_query(Query(**locals()))
-
-
 @router.command(
     model="EtfEquityExposure",
     examples=[

openbb_platform/providers/fmp/openbb_fmp/__init__.py

@@ -34,7 +34,6 @@
 from openbb_fmp.models.etf_equity_exposure import FMPEtfEquityExposureFetcher
 from openbb_fmp.models.etf_holdings import FMPEtfHoldingsFetcher
 from openbb_fmp.models.etf_holdings_date import FMPEtfHoldingsDateFetcher
-from openbb_fmp.models.etf_holdings_performance import FMPEtfHoldingsPerformanceFetcher
 from openbb_fmp.models.etf_info import FMPEtfInfoFetcher
 from openbb_fmp.models.etf_search import FMPEtfSearchFetcher
 from openbb_fmp.models.etf_sectors import FMPEtfSectorsFetcher
@@ -102,7 +101,6 @@
         "EtfEquityExposure": FMPEtfEquityExposureFetcher,
         "EtfHoldings": FMPEtfHoldingsFetcher,
         "EtfHoldingsDate": FMPEtfHoldingsDateFetcher,
-        "EtfHoldingsPerformance": FMPEtfHoldingsPerformanceFetcher,
         "EtfInfo": FMPEtfInfoFetcher,
         "EtfPricePerformance": FMPPricePerformanceFetcher,
         "EtfSearch": FMPEtfSearchFetcher,