summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanglewood <85772166+deeleeramone@users.noreply.github.com>2024-06-07 23:31:41 -0700
committerDanglewood <85772166+deeleeramone@users.noreply.github.com>2024-06-07 23:31:41 -0700
commitebd07afdd62716576bfd0d0a3716bcfcc5cc5b97 (patch)
tree51e3537520de6003a88bc56702c32d6862573392
parent3ed1f5907b19849652bdc44ba26770d926215b08 (diff)
examples
-rw-r--r--openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py1
-rw-r--r--openbb_platform/extensions/fixedincome/openbb_fixedincome/rate/rate_router.py1
-rw-r--r--openbb_platform/openbb/assets/reference.json4
-rw-r--r--openbb_platform/openbb/package/fixedincome.py1
-rw-r--r--openbb_platform/openbb/package/fixedincome_rate.py1
5 files changed, 2 insertions, 6 deletions
diff --git a/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py b/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py
index 0d0d274d3bf..2da62f94dcf 100644
--- a/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py
+++ b/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py
@@ -30,7 +30,6 @@ router.include_router(corporate_router)
model="SOFR",
examples=[
APIEx(parameters={"provider": "fred"}),
- APIEx(parameters={"period": "overnight", "provider": "fred"}),
],
deprecated=True,
deprecation=OpenBBDeprecationWarning(
diff --git a/openbb_platform/extensions/fixedincome/openbb_fixedincome/rate/rate_router.py b/openbb_platform/extensions/fixedincome/openbb_fixedincome/rate/rate_router.py
index ad43d8ccb7c..e86119d5f84 100644
--- a/openbb_platform/extensions/fixedincome/openbb_fixedincome/rate/rate_router.py
+++ b/openbb_platform/extensions/fixedincome/openbb_fixedincome/rate/rate_router.py
@@ -64,7 +64,6 @@ async def sonia(
model="SOFR",
examples=[
APIEx(parameters={"provider": "fred"}),
- APIEx(parameters={"period": "overnight", "provider": "fred"}),
],
)
async def sofr(
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index ae90ec2747d..e6c85cdb235 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -30071,7 +30071,7 @@
"message": null
},
"description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.",
- "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sofr(provider='fred')\nobb.fixedincome.rate.sofr(period=overnight, provider='fred')\n```\n\n",
+ "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.rate.sofr(provider='fred')\n```\n\n",
"parameters": {
"standard": [
{
@@ -32371,7 +32371,7 @@
"message": "This endpoint is deprecated; use `/fixedincome/rate/sofr` instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.5."
},
"description": "Secured Overnight Financing Rate.\n\nThe Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of\nborrowing cash overnight collateralizing by Treasury securities.",
- "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.sofr(provider='fred')\nobb.fixedincome.sofr(period=overnight, provider='fred')\n```\n\n",
+ "examples": "\nExamples\n--------\n\n```python\nfrom openbb import obb\nobb.fixedincome.sofr(provider='fred')\n```\n\n",
"parameters": {
"standard": [
{
diff --git a/openbb_platform/openbb/package/fixedincome.py b/openbb_platform/openbb/package/fixedincome.py
index a7e043d10b5..0483f2bd2d5 100644
--- a/openbb_platform/openbb/package/fixedincome.py
+++ b/openbb_platform/openbb/package/fixedincome.py
@@ -314,7 +314,6 @@ class ROUTER_fixedincome(Container):
--------
>>> from openbb import obb
>>> obb.fixedincome.sofr(provider='fred')
- >>> obb.fixedincome.sofr(period=overnight, provider='fred')
""" # noqa: E501
simplefilter("always", DeprecationWarning)
diff --git a/openbb_platform/openbb/package/fixedincome_rate.py b/openbb_platform/openbb/package/fixedincome_rate.py
index 543d48aee1d..2e2508bc588 100644
--- a/openbb_platform/openbb/package/fixedincome_rate.py
+++ b/openbb_platform/openbb/package/fixedincome_rate.py
@@ -793,7 +793,6 @@ class ROUTER_fixedincome_rate(Container):
--------
>>> from openbb import obb
>>> obb.fixedincome.rate.sofr(provider='fred')
- >>> obb.fixedincome.rate.sofr(period=overnight, provider='fred')
""" # noqa: E501
return self._run(