Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IMPROVE] There is no way to change the defaulted provider of CI docs #6973

Open
joshuaBri opened this issue Nov 28, 2024 · 2 comments
Open

Comments

@joshuaBri
Copy link
Contributor

image
I know set the value of defaults in user_settings.json.
Then I can run "obb.economy.cpi(country="united_states,united_kingdom",transform="period")" ,which without parameter "provider".
But that's not what require.
I want to change the default value in CI docs.
This is my application scenario. We are preparing to develop an internal OpenBB environment, and I want the default provider in the CI documentation to be usable. We do not support all providers. I would like to know where the default provider in the CI documentation is configured. I would greatly appreciate your help if you can assist me.

@deeleeramone
Copy link
Contributor

deeleeramone commented Nov 28, 2024

Apologies, the documentation section needs to be updated.

The default value is defined by user_settings.json, and you will need to define the function with slashes, like the API route:

"/economy/cpi"

Please note that this will not change what the docstring says, default values are injected at runtime. The FastAPI documentation and Python docstrings are created based on the specific components you have installed.

If you are planning to not support specific providers, the best thing to do is uninstall them, or install only the router and provider components you would like to use. Each one is its own installable package.

@joshuaBri
Copy link
Contributor Author

Got it ,Thanks a lot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants