diff --git a/openbb_platform/platform/core/README.md b/openbb_platform/platform/core/README.md index 54a66cec891..473e75121ec 100644 --- a/openbb_platform/platform/core/README.md +++ b/openbb_platform/platform/core/README.md @@ -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 diff --git a/openbb_platform/platform/core/openbb_core/env.py b/openbb_platform/platform/core/openbb_core/env.py index 02c89b3fca8..3ce1ed909ba 100644 --- a/openbb_platform/platform/core/openbb_core/env.py +++ b/openbb_platform/platform/core/openbb_core/env.py @@ -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