rename key and update docs

28 files changed, 162 insertions, 137 deletions

diff --git a/openbb_platform/core/openbb_core/app/model/defaults.py b/openbb_platform/core/openbb_core/app/model/defaults.py
index 97e00df559b..7c92a4ff62a 100644
--- a/openbb_platform/core/openbb_core/app/model/defaults.py
+++ b/openbb_platform/core/openbb_core/app/model/defaults.py
@@ -1,18 +1,21 @@
 """Defaults model."""
 
 from typing import Dict, List, Optional, Union
+from warnings import warn
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+
+from openbb_core.app.model.abstract.warning import OpenBBWarning
 
 
 class Defaults(BaseModel):
     """Defaults."""
 
-    model_config = ConfigDict(validate_assignment=True)
+    model_config = ConfigDict(validate_assignment=True, populate_by_name=True)
 
     commands: Dict[str, Dict[str, Optional[Union[str, List[str]]]]] = Field(
         default_factory=dict,
-        alias="routes",  # routes was deprecated in favor of commands
+        alias="routes",
     )
 
     def __repr__(self) -> str:
@@ -20,3 +23,19 @@ class Defaults(BaseModel):
         return f"{self.__class__.__name__}\n\n" + "\n".join(
             f"{k}: {v}" for k, v in self.model_dump().items()
         )
+
+    @model_validator(mode="before")
+    @classmethod
+    def validate_before(cls, values: dict) -> dict:
+        """Validate model (before)."""
+        key = "commands"
+        if "routes" in values:
+            warn(
+                message="'routes' is deprecated. Use 'commands' instead.",
+                category=OpenBBWarning,
+            )
+            key = "routes"
+        values[key] = {
+            k.strip("/").replace("/", "."): v for k, v in values[key].items()
+        }
+        return values
diff --git a/openbb_platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/core/openbb_core/app/static/package_builder.py
index cbfbfc125b1..e614aaf2463 100644
--- a/openbb_platform/core/openbb_core/app/static/package_builder.py
+++ b/openbb_platform/core/openbb_core/app/static/package_builder.py
@@ -828,10 +828,11 @@ class MethodDefinition:
             elif name == "provider_choices":
                 field = param.annotation.__args__[0].__dataclass_fields__["provider"]
                 available = field.type.__args__
+                cmd = path.strip("/").replace("/", ".")
                 code += "                provider_choices={\n"
                 code += '                    "provider": self._get_provider(\n'
                 code += "                        provider,\n"
-                code += f'                        "{path}",\n'
+                code += f'                        "{cmd}",\n'
                 code += f"                        {available},\n"
                 code += "                    )\n"
                 code += "                },\n"
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index 1aaa7682427..cfdc8fcacbe 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -29525,8 +29525,8 @@
                 "econdb": [
                     {
                         "name": "country",
-                        "type": "Literal['australia', 'canada', 'china', 'hong_kong', 'india', 'japan', 'russia', 'saudi_arabia', 'south_africa', 'south_korea', 'taiwan', 'united_kingdom', 'united_states']",
-                        "description": "The country to get data.",
+                        "type": "Literal['australia', 'canada', 'china', 'hong_kong', 'india', 'japan', 'mexico', 'new_zealand', 'russia', 'saudi_arabia', 'singapore', 'south_africa', 'south_korea', 'taiwan', 'thailand', 'united_kingdom', 'united_states']",
+                        "description": "The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used.",
                         "default": "united_states",
                         "optional": true,
                         "choices": [
@@ -29536,11 +29536,15 @@
                             "hong_kong",
                             "india",
                             "japan",
+                            "mexico",
+                            "new_zealand",
                             "russia",
                             "saudi_arabia",
+                            "singapore",
                             "south_africa",
                             "south_korea",
                             "taiwan",
+                            "thailand",
                             "united_kingdom",
                             "united_states"
                         ]
@@ -29633,7 +29637,7 @@
         "/fixedincome/government/us_yield_curve": {
             "deprecated": {
                 "flag": true,
-                "message": "This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.1 to be removed in V4.3."
+                "message": "This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4."
             },
             "description": "US Yield Curve. Get United States yield curve.",
             "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.government.us_yield_curve(provider='fred')\nobb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')\n```\n\n",
diff --git a/openbb_platform/openbb/package/crypto.py b/openbb_platform/openbb/package/crypto.py
index 246dbc86584..1e2124d5ae8 100644
--- a/openbb_platform/openbb/package/crypto.py
+++ b/openbb_platform/openbb/package/crypto.py
@@ -92,7 +92,7 @@ class ROUTER_crypto(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/crypto/search",
+                        "crypto.search",
                         ("fmp",),
                     )
                 },
diff --git a/openbb_platform/openbb/package/crypto_price.py b/openbb_platform/openbb/package/crypto_price.py
index bbd332f8d18..a90e4e1db99 100644
--- a/openbb_platform/openbb/package/crypto_price.py
+++ b/openbb_platform/openbb/package/crypto_price.py
@@ -125,7 +125,7 @@ class ROUTER_crypto_price(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/crypto/price/historical",
+                        "crypto.price.historical",
                         ("fmp", "polygon", "tiingo", "yfinance"),
                     )
                 },
diff --git a/openbb_platform/openbb/package/currency.py b/openbb_platform/openbb/package/currency.py
index ba7d31d21cb..6db8855dfd2 100644
--- a/openbb_platform/openbb/package/currency.py
+++ b/openbb_platform/openbb/package/currency.py
@@ -124,7 +124,7 @@ class ROUTER_currency(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/currency/search",
+                        "currency.search",
                         ("fmp", "intrinio", "polygon"),
                     )
                 },
@@ -280,7 +280,7 @@ class ROUTER_currency(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/currency/snapshots",
+                        "currency.snapshots",
                         ("fmp", "polygon"),
                     )
                 },
diff --git a/openbb_platform/openbb/package/currency_price.py b/openbb_platform/openbb/package/currency_price.py
index 251e422f05d..a9964703c83 100644
--- a/openbb_platform/openbb/package/currency_price.py
+++ b/openbb_platform/openbb/package/currency_price.py
@@ -128,7 +128,7 @@ class ROUTER_currency_price(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/currency/price/historical",
+                        "currency.price.historical",
                         ("fmp", "polygon", "tiingo", "yfinance"),
                     )
                 },
diff --git a/openbb_platform/openbb/package/derivatives_options.py b/openbb_platform/openbb/package/derivatives_options.py
index 4490181503d..664b238bc7e 100644
--- a/openbb_platform/openbb/package/derivatives_options.py
+++ b/openbb_platform/openbb/package/derivatives_options.py
@@ -164,7 +164,7 @@ class ROUTER_derivatives_options(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/derivatives/options/chains",
+                        "derivatives.options.chains",
                         ("intrinio",),
                     )
                 },
@@ -271,7 +271,7 @@ class ROUTER_derivatives_options(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/derivatives/options/unusual",
+                        "derivatives.options.unusual",
                         ("intrinio",),
                     )
                 },
diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py
index 0a589831355..07bad9934fd 100644
--- a/openbb_platform/openbb/package/economy.py
+++ b/openbb_platform/openbb/package/economy.py
@@ -114,7 +114,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/available_indicators",
+                        "economy.available_indicators",
                         ("econdb",),
                     )
                 },
@@ -222,7 +222,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/balance_of_payments",
+                        "economy.balance_of_payments",
                         ("fred",),
                     )
                 },
@@ -354,7 +354,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/calendar",
+                        "economy.calendar",
                         ("fmp", "tradingeconomics"),
                     )
                 },
@@ -449,7 +449,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/composite_leading_indicator",
+                        "economy.composite_leading_indicator",
                         ("oecd",),
                     )
                 },
@@ -553,7 +553,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/country_profile",
+                        "economy.country_profile",
                         ("econdb",),
                     )
                 },
@@ -721,7 +721,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/cpi",
+                        "economy.cpi",
                         ("fred",),
                     )
                 },
@@ -874,7 +874,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/fred_regional",
+                        "economy.fred_regional",
                         ("fred",),
                     )
                 },
@@ -1005,7 +1005,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/fred_search",
+                        "economy.fred_search",
                         ("fred",),
                     )
                 },
@@ -1144,7 +1144,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/fred_series",
+                        "economy.fred_series",
                         ("fred", "intrinio"),
                     )
                 },
@@ -1273,7 +1273,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/indicators",
+                        "economy.indicators",
                         ("econdb",),
                     )
                 },
@@ -1374,7 +1374,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/long_term_interest_rate",
+                        "economy.long_term_interest_rate",
                         ("oecd",),
                     )
                 },
@@ -1474,7 +1474,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/money_measures",
+                        "economy.money_measures",
                         ("federal_reserve",),
                     )
                 },
@@ -1545,7 +1545,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/risk_premium",
+                        "economy.risk_premium",
                         ("fmp",),
                     )
                 },
@@ -1635,7 +1635,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/short_term_interest_rate",
+                        "economy.short_term_interest_rate",
                         ("oecd",),
                     )
                 },
@@ -1728,7 +1728,7 @@ class ROUTER_economy(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/unemployment",
+                        "economy.unemployment",
                         ("oecd",),
                     )
                 },
diff --git a/openbb_platform/openbb/package/economy_gdp.py b/openbb_platform/openbb/package/economy_gdp.py
index 3f26966bffb..3ce3262e774 100644
--- a/openbb_platform/openbb/package/economy_gdp.py
+++ b/openbb_platform/openbb/package/economy_gdp.py
@@ -106,7 +106,7 @@ class ROUTER_economy_gdp(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/gdp/forecast",
+                        "economy.gdp.forecast",
                         ("oecd",),
                     )
                 },
@@ -197,7 +197,7 @@ class ROUTER_economy_gdp(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/gdp/nominal",
+                        "economy.gdp.nominal",
                         ("oecd",),
                     )
                 },
@@ -287,7 +287,7 @@ class ROUTER_economy_gdp(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/economy/gdp/real",
+                        "economy.gdp.real",
                         ("oecd",),
                     )
                 },
diff --git a/openbb_platform/openbb/package/equity.py b/openbb_platform/openbb/package/equity.py
index 922618dae0a..3e3727a4dd6 100644
--- a/openbb_platform/openbb/package/equity.py
+++ b/openbb_platform/openbb/package/equity.py
@@ -222,7 +222,7 @@ class ROUTER_equity(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/market_snapshots",
+                        "equity.market_snapshots",
                         ("fmp", "intrinio", "polygon"),
                     )
                 },
@@ -426,7 +426,7 @@ class ROUTER_equity(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/profile",
+                        "equity.profile",
                         ("fmp", "intrinio", "yfinance"),
                     )
                 },
@@ -559,7 +559,7 @@ class ROUTER_equity(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/screener",
+                        "equity.screener",
                         ("fmp",),
                     )
                 },
@@ -648,7 +648,7 @@ class ROUTER_equity(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/search",
+                        "equity.search",
                         ("intrinio", "sec"),
                     )
                 },
diff --git a/openbb_platform/openbb/package/equity_calendar.py b/openbb_platform/openbb/package/equity_calendar.py
index 891ac9995f0..deb76168f69 100644
--- a/openbb_platform/openbb/package/equity_calendar.py
+++ b/openbb_platform/openbb/package/equity_calendar.py
@@ -102,7 +102,7 @@ class ROUTER_equity_calendar(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/calendar/dividend",
+                        "equity.calendar.dividend",
                         ("fmp",),
                     )
                 },
@@ -200,7 +200,7 @@ class ROUTER_equity_calendar(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/calendar/earnings",
+                        "equity.calendar.earnings",
                         ("fmp",),
                     )
                 },
@@ -337,7 +337,7 @@ class ROUTER_equity_calendar(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/calendar/ipo",
+                        "equity.calendar.ipo",
                         ("intrinio",),
                     )
                 },
@@ -425,7 +425,7 @@ class ROUTER_equity_calendar(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/calendar/splits",
+                        "equity.calendar.splits",
                         ("fmp",),
                     )
                 },
diff --git a/openbb_platform/openbb/package/equity_compare.py b/openbb_platform/openbb/package/equity_compare.py
index e167cb9faa6..55e082ba401 100644
--- a/openbb_platform/openbb/package/equity_compare.py
+++ b/openbb_platform/openbb/package/equity_compare.py
@@ -126,7 +126,7 @@ class ROUTER_equity_compare(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/compare/company_facts",
+                        "equity.compare.company_facts",
                         ("sec",),
                     )
                 },
@@ -198,7 +198,7 @@ class ROUTER_equity_compare(Container):
                 provider_choices={
                     "provider": self._get_provider(
                         provider,
-                        "/equity/compare/peers",
+                        "equity.compare.peers",
                         ("fmp",),
                     )
                 },
diff --git a/openbb_platform/openbb/package/equity_discovery.py b/openbb_platform/openbb/package/equity_discovery.py
index 770a2ce6dae..278e154e587 100644
--- a/openbb_platform/openbb/package/equity_discovery.py
+++ b/