Introduces a limit argument for the `equity.fundamental.trailing_divi…

…dend_yield` endpoint (#5925)

* introduces a limit argument for the equity.fundamental.trailing_dividend_yield endpoint

* add default args to test

openbb_platform/core/openbb_core/provider/standard_models/trailing_dividend_yield.py

@@ -2,6 +2,7 @@
 
 
 from datetime import date as dateType
+from typing import Optional
 
 from pydantic import Field
 
@@ -17,6 +18,11 @@ class TrailingDivYieldQueryParams(QueryParams):
     """Trailing Dividend Yield Query."""
 
     symbol: str = Field(default=None, description=QUERY_DESCRIPTIONS.get("symbol", ""))
+    limit: Optional[int] = Field(
+        default=252,
+        description=f"{QUERY_DESCRIPTIONS.get('limit', '')}"
+        " Default is 252, the number of trading days in a year.",
+    )
 
 
 class TrailingDivYieldData(Data):

openbb_platform/extensions/equity/integration/test_equity_api.py

@@ -1442,7 +1442,7 @@ def test_equity_fundamental_historical_eps(params, headers):
 
 @parametrize(
     "params",
-    [({"provider": "tiingo", "symbol": "AAPL"})],
+    [({"provider": "tiingo", "symbol": "AAPL", "limit": 10})],
 )
 @pytest.mark.integration
 def test_equity_fundamental_trailing_dividend_yield(params, headers):

openbb_platform/extensions/equity/integration/test_equity_python.py

@@ -1361,7 +1361,7 @@ def test_equity_fundamental_historical_eps(params, obb):
 
 @parametrize(
     "params",
-    [({"provider": "tiingo", "symbol": "AAPL"})],
+    [({"provider": "tiingo", "symbol": "AAPL", "limit": 10})],
 )
 @pytest.mark.integration
 def test_equity_fundamental_trailing_dividend_yield(params, obb):

openbb_platform/providers/tiingo/openbb_tiingo/models/trailing_dividend_yield.py

@@ -37,7 +37,7 @@ def transform_query(params: Dict[str, Any]) -> TiingoTrailingDivYieldQueryParams
         transformed_params = params
         return TiingoTrailingDivYieldQueryParams(**transformed_params)
 
-    # pylint: disable=protected-access
+    # pylint: disable=unused-argument
     @staticmethod
     def extract_data(
         query: TiingoTrailingDivYieldQueryParams,
@@ -60,4 +60,5 @@ def transform_data(
         **kwargs: Any,
     ) -> List[TiingoTrailingDivYieldData]:
         """Return the transformed data."""
+        data = data[-query.limit :] if query.limit else data
         return [TiingoTrailingDivYieldData.model_validate(d) for d in data]