Data Models disposition on the website (#5538)

* pydantic v4

* flat structure

* md files

* Revert "md files"

This reverts commit bd2170e.

* improve command descriptions

* nice title and description

* human readble data model names on left panel

* implementation details section

* content markdown files

* markdown versioned files

* showcase page

* updates

---------

Co-authored-by: tehcoderer <[email protected]>

openbb_platform/extensions/crypto/openbb_crypto/crypto_router.py

@@ -20,5 +20,5 @@ def load(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Crypto Historical Price."""
+    """Crypto Historical Price. Cryptocurrency historical price data."""
     return OBBject(results=Query(**locals()).execute())

openbb_platform/extensions/economy/openbb_economy/economy_router.py

@@ -25,7 +25,7 @@ def const(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Get the constituents of an index."""
+    """Major Indices Constituents. Constituents of an index."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -36,7 +36,7 @@ def cpi(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """CPI."""
+    """CPI. Consumer Price Index."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -47,7 +47,7 @@ def index(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Get historical  levels for an index."""
+    """Major Indices Historical. Historical  levels for an index."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -58,7 +58,7 @@ def european_index(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Get historical close values for select European indices."""
+    """European Index Historical. Historical close values for selected European indices."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -80,7 +80,7 @@ def available_indices(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Lists of available indices from a provider."""
+    """Available Indices. Available indices for a given provider."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -91,7 +91,7 @@ def risk(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Market Risk Premium."""
+    """Market Risk Premium. Historical market risk premium."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -102,7 +102,7 @@ def index_search(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Search for indices."""
+    """Index Search. Search for indices."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -113,7 +113,7 @@ def index_snapshots(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Get current  levels for all indices from a provider."""
+    """Index Snapshots. Current levels for all indices from a provider."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -124,7 +124,10 @@ def cot_search(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Fuzzy search and list of curated Commitment of Traders Reports series information."""
+    """
+    Curated Commitment of Traders Reports.
+    Fuzzy search and list of curated Commitment of Traders Reports series information.
+    """
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -135,7 +138,7 @@ def cot(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Lookup Commitment of Traders Reports by series ID."""
+    """Commitment of Traders Reports. Lookup Commitment of Traders Reports by series ID."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -146,7 +149,7 @@ def sp500_multiples(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Historical S&P 500 multiples and Shiller PE ratios."""
+    """S&P 500 Multiples. Historical S&P 500 multiples and Shiller PE ratios."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -157,7 +160,7 @@ def fred_index(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Fred Historical."""
+    """Fred Historical. Historical close values for selected Fred indices."""
     return OBBject(results=Query(**locals()).execute())
 
 

openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py

@@ -21,7 +21,7 @@ def treasury(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Get treasury rates."""
+    """Treasury Rates. Treasury rates data."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -32,7 +32,7 @@ def ycrv(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
-    """Get United States yield curve."""
+    """US Yield Curve. Get United States yield curve."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -43,7 +43,11 @@ def sofr(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
-    """Get United States yield curve."""
+    """
+    Secured Overnight Financing Rate.
+    The Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of
+    borrowing cash overnight collateralized by Treasury securities.
+    """
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -55,6 +59,7 @@ def estr(
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
     """
+    Euro Short-Term Rate.
     The euro short-term rate (€STR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in
     the euro area. The €STR is published on each TARGET2 business day based on transactions conducted and settled on
     the previous TARGET2 business day (the reporting date “T”) with a maturity date of T+1 which are deemed to have been
@@ -70,6 +75,7 @@ def sonia(
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
     """
+    Sterling Overnight Index Average.
     SONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual
     transactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other
     financial institutions and other institutional investors."""
@@ -84,6 +90,7 @@ def ameribor(
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
     """
+    Ameribor.
     Ameribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of
     short-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the
     American Financial Exchange (AFX)."""
@@ -98,6 +105,7 @@ def fed(
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
     """
+    Fed Funds Rate.
     Get Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its
     domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the
     United States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.
@@ -113,9 +121,11 @@ def projections(
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
     """
-    Get Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its
-    domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the
-    United States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.
+    Fed Funds Rate Projections.
+    The projections for the federal funds rate are the value of the midpoint of the
+    projected appropriate target range for the federal funds rate or the projected
+    appropriate target level for the federal funds rate at the end of the specified
+    calendar year or over the longer run.
     """
     return OBBject(results=Query(**locals()).execute())
 
@@ -128,6 +138,7 @@ def iorb(
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:  # type: ignore
     """
+    Interest on Reserve Balances.
     Get Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its
     domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the
     United States, the Federal Reserve System's Board of Governors set the bank rate, also known as the discount rate.

openbb_platform/extensions/forex/openbb_forex/forex_router.py

@@ -20,7 +20,7 @@ def pairs(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Forex Available Pairs."""
+    """Forex Pairs. Forex available pairs."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -32,5 +32,5 @@ def load(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Forex Intraday Price."""
+    """Forex Historical Price. Forex historical data."""
     return OBBject(results=Query(**locals()).execute())

openbb_platform/extensions/futures/openbb_futures/futures_router.py

@@ -20,7 +20,7 @@ def load(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Futures Historical Price."""
+    """Futures Historical Price. Futures historical data."""
     return OBBject(results=Query(**locals()).execute())
 
 
@@ -31,5 +31,5 @@ def curve(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Futures Historical Price."""
+    """Futures Historical Price. Futures historical data."""
     return OBBject(results=Query(**locals()).execute())

openbb_platform/extensions/news/openbb_news/news_router.py

@@ -22,5 +22,5 @@ def globalnews(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Global News."""
+    """Global News. Global news data."""
     return OBBject(results=Query(**locals()).execute())

openbb_platform/extensions/stocks/openbb_stocks/ca/ca_router.py

@@ -22,5 +22,5 @@ def peers(
     standard_params: StandardParams,
     extra_params: ExtraParams,
 ) -> OBBject[BaseModel]:
-    """Company peers."""
+    """Stock Peers. Company peers."""
     return OBBject(results=Query(**locals()).execute())