diff options
Diffstat (limited to 'website/content/platform/developer_guide/deprecating_endpoints.mdx')
-rw-r--r-- | website/content/platform/developer_guide/deprecating_endpoints.mdx | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/website/content/platform/developer_guide/deprecating_endpoints.mdx b/website/content/platform/developer_guide/deprecating_endpoints.mdx new file mode 100644 index 00000000000..cda58a8de4c --- /dev/null +++ b/website/content/platform/developer_guide/deprecating_endpoints.mdx @@ -0,0 +1,54 @@ +--- +title: Deprecating Endpoints +sidebar_position: 11 +description: This guide provides detailed instructions on how to deprecate an endpoint in the OpenBB Platform. +keywords: +- OpenBB community +- OpenBB Platform +- Custom commands +- API +- Python Interface +- Deprecation +- Deprecated +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + +<HeadTitle title="Deprecating Endpoints - How-To | OpenBB Platform Docs" /> + +Deprecating commands is essential to maintaining the OpenBB Platform. This guide outlines the process for deprecating an endpoint. + +## Deprecating an endpoint + +1. Add the new endpoint that will replace the deprecated one. + +2. Add the deprecation warning + + Navigate to the **router** where the endpoint to be deprecated exists. Set the `deprecated` flag to `True` and add `deprecation=OpenBBDeprecationWarning(…)` argument to the decorator. Refer to the example below: + + ```python + + from openbb_core.app.deprecation import OpenBBDeprecationWarning + + @router.command( + model="MarketIndices", + deprecated=True, + deprecation=OpenBBDeprecationWarning( + message="This endpoint is deprecated; use `/index/price/historical` instead.", + since=(4, 1), + expected_removal=(4, 5), + ), + ) + async def market( + cc: CommandContext, + provider_choices: ProviderChoices, + standard_params: StandardParams, + extra_params: ExtraParams, + ) -> OBBject: + """Historical Market Indices.""" + return await OBBject.from_query(Query(**locals())) + ``` + +3. Get approval from a OpenBB Platform maintainer: We will help you determine the appropriate version for the deprecation warning, and communicate the change(s) to the relevant personnel that might depend on the endpoint you are deprecating. + +4. Remove as we say - the endpoint will be removed in the version specified in the deprecation warning. |