jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 23:12:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docstrings and readme

Browse Source
This commit is contained in:
Diogo Sousa
2023-10-06 18:24:33 +01:00
parent 59fcce4466
commit 66f9ffd845
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
openbb_platform/platform/core/README.md vendored
View File

@@ -355,7 +355,7 @@ To apply an environment variable use one of the following:
The variables we use are:
- `OPENBB_API_AUTH`: enables API authentication for command endpoints
- `OPENBB_API_AUTH`: enables API endpoint authentication
- `OPENBB_API_USERNAME`: sets API username
- `OPENBB_API_PASSWORD`: sets API password
- `OPENBB_API_AUTH_EXTENSION`: specifies which authentication extension to use

2
openbb_platform/platform/core/openbb_core/env.py
View File

@@ -19,7 +19,7 @@ class Env(metaclass=SingletonMeta):
@property
def API_AUTH(self) -> bool:
"""API authentication: enables commands authentication in FastAPI"""
"""API authentication: enables API endpoint authentication"""
return self.str2bool(self._environ.get("OPENBB_API_AUTH", False))
@property