summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiogo Sousa <montezdesousa@gmail.com>2024-05-21 23:23:35 +0100
committerDiogo Sousa <montezdesousa@gmail.com>2024-05-21 23:23:35 +0100
commit61d2043e85a7fc0423be03eb8555bac23a7d0be2 (patch)
treebd948bc0e1747b887c20ec2c7bd61e35277d2ddc
parent99436020df4058424b9754ddb0c193c0f3411776 (diff)
fix: provider field description
-rw-r--r--openbb_platform/core/openbb_core/app/static/package_builder.py4
-rw-r--r--openbb_platform/openbb/assets/reference.json258
-rw-r--r--openbb_platform/openbb/package/crypto.py4
-rw-r--r--openbb_platform/openbb/package/crypto_price.py4
-rw-r--r--openbb_platform/openbb/package/currency.py8
-rw-r--r--openbb_platform/openbb/package/currency_price.py4
-rw-r--r--openbb_platform/openbb/package/derivatives_options.py8
-rw-r--r--openbb_platform/openbb/package/economy.py60
-rw-r--r--openbb_platform/openbb/package/economy_gdp.py12
-rw-r--r--openbb_platform/openbb/package/equity.py16
-rw-r--r--openbb_platform/openbb/package/equity_calendar.py16
-rw-r--r--openbb_platform/openbb/package/equity_compare.py8
-rw-r--r--openbb_platform/openbb/package/equity_discovery.py32
-rw-r--r--openbb_platform/openbb/package/equity_estimates.py32
-rw-r--r--openbb_platform/openbb/package/equity_fundamental.py100
-rw-r--r--openbb_platform/openbb/package/equity_ownership.py20
-rw-r--r--openbb_platform/openbb/package/equity_price.py16
-rw-r--r--openbb_platform/openbb/package/equity_shorts.py4
-rw-r--r--openbb_platform/openbb/package/etf.py36
-rw-r--r--openbb_platform/openbb/package/fixedincome.py4
-rw-r--r--openbb_platform/openbb/package/fixedincome_corporate.py20
-rw-r--r--openbb_platform/openbb/package/fixedincome_government.py12
-rw-r--r--openbb_platform/openbb/package/fixedincome_rate.py32
-rw-r--r--openbb_platform/openbb/package/fixedincome_spreads.py12
-rw-r--r--openbb_platform/openbb/package/index.py12
-rw-r--r--openbb_platform/openbb/package/news.py8
26 files changed, 371 insertions, 371 deletions
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 3a40f395694..88ffb633279 100644
--- a/openbb_platform/core/openbb_core/app/static/package_builder.py
+++ b/openbb_platform/core/openbb_core/app/static/package_builder.py
@@ -609,7 +609,7 @@ class MethodDefinition:
description=(
"The provider to use, by default None. "
"If None, the priority list configured in the settings is used. "
- f"Default priority: {default_priority}"
+ f"Default priority: {', '.join(default_priority)}."
),
),
],
@@ -1420,7 +1420,7 @@ class ReferenceGenerator:
description = (
"The provider to use, by default None. "
"If None, the priority list configured in the settings is used. "
- f"Default priority: {default_priority}"
+ f"Default priority: {', '.join(default_priority)}."
)
provider_parameter_info = {
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index fde02bf1efe..2272d60c8ec 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -72,7 +72,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'polygon', 'tiingo', 'yfinance']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -308,7 +308,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -428,7 +428,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'polygon', 'tiingo', 'yfinance']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -639,7 +639,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'intrinio', 'polygon']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -845,7 +845,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'polygon']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -1200,7 +1200,7 @@
{
"name": "provider",
"type": "Literal['intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.",
"default": null,
"optional": true
}
@@ -1625,7 +1625,7 @@
{
"name": "provider",
"type": "Literal['intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.",
"default": null,
"optional": true
}
@@ -1866,7 +1866,7 @@
{
"name": "provider",
"type": "Literal['yfinance']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: y, f, i, n, a, n, c, e.",
"default": null,
"optional": true
}
@@ -1994,7 +1994,7 @@
{
"name": "provider",
"type": "Literal['yfinance']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: y, f, i, n, a, n, c, e.",
"default": null,
"optional": true
}
@@ -2097,7 +2097,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -2201,7 +2201,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -2305,7 +2305,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -2401,7 +2401,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'tradingeconomics']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -3015,7 +3015,7 @@
{
"name": "provider",
"type": "Literal['fred']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.",
"default": null,
"optional": true
}
@@ -3078,7 +3078,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -3165,7 +3165,7 @@
{
"name": "provider",
"type": "Literal['fred']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.",
"default": null,
"optional": true
}
@@ -3421,7 +3421,7 @@
{
"name": "provider",
"type": "Literal['fred']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.",
"default": null,
"optional": true
}
@@ -3742,7 +3742,7 @@
{
"name": "provider",
"type": "Literal['fred', 'intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.",
"default": null,
"optional": true
}
@@ -3890,7 +3890,7 @@
{
"name": "provider",
"type": "Literal['federal_reserve']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, e, d, e, r, a, l, _, r, e, s, e, r, v, e.",
"default": null,
"optional": true
}
@@ -4025,7 +4025,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -4161,7 +4161,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -4265,7 +4265,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -4377,7 +4377,7 @@
{
"name": "provider",
"type": "Literal['oecd']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: o, e, c, d.",
"default": null,
"optional": true
}
@@ -4505,7 +4505,7 @@
{
"name": "provider",
"type": "Literal['fred']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, r, e, d.",
"default": null,
"optional": true
}
@@ -4674,7 +4674,7 @@
{
"name": "provider",
"type": "Literal['econdb']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: e, c, o, n, d, b.",
"default": null,
"optional": true
}
@@ -4858,7 +4858,7 @@
{
"name": "provider",
"type": "Literal['econdb']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: e, c, o, n, d, b.",
"default": null,
"optional": true
}
@@ -5067,7 +5067,7 @@
{
"name": "provider",
"type": "Literal['econdb']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: e, c, o, n, d, b.",
"default": null,
"optional": true
}
@@ -5219,7 +5219,7 @@
{
"name": "provider",
"type": "Literal['intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.",
"default": null,
"optional": true
}
@@ -5492,7 +5492,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -5636,7 +5636,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -5747,7 +5747,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -5899,7 +5899,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -5978,7 +5978,7 @@
{
"name": "provider",
"type": "Literal['sec']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: s, e, c.",
"default": null,
"optional": true
}
@@ -6492,7 +6492,7 @@
{
"name": "provider",
"type": "Literal['benzinga', 'fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: b, e, n, z, i, n, g, a.",
"default": null,
"optional": true
}
@@ -6881,7 +6881,7 @@
{
"name": "provider",
"type": "Literal['fmp']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -7137,7 +7137,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'intrinio', 'yfinance']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -7359,7 +7359,7 @@
{
"name": "provider",
"type": "Literal['benzinga']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: benzinga",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: b, e, n, z, i, n, g, a.",
"default": null,
"optional": true
}
@@ -7912,7 +7912,7 @@
{
"name": "provider",
"type": "Literal['intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.",
"default": null,
"optional": true
}
@@ -8185,7 +8185,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -8413,7 +8413,7 @@
{
"name": "provider",
"type": "Literal['fmp', 'intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: f, m, p.",
"default": null,
"optional": true
}
@@ -8681,7 +8681,7 @@
{
"name": "provider",
"type": "Literal['intrinio']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: intrinio",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: i, n, t, r, i, n, i, o.",
"default": null,
"optional": true
}
@@ -8825,7 +8825,7 @@
{
"name": "provider",
"type": "Literal['yfinance']",
- "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: yfinance",
+ "description": "The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: y, f, i, n, a, n, c, e.",
"default": null,