From 9db086bf2ef238527a10958d820b84be622c11e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Wed, 19 Aug 2020 16:34:17 +0200 Subject: [PATCH] Document openedx/core/djangoapps/oauth_dispatch feature toggles --- lms/envs/common.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index f9ff752184..5b64aa7544 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -127,7 +127,20 @@ FEATURES = { 'DISABLE_LOGIN_BUTTON': False, # used in systems where login is automatic, eg MIT SSL - # Toggles OAuth2 authentication provider + """ + .. toggle_name: ENABLE_OAUTH2_PROVIDER + .. toggle_implementation: DjangoSetting + .. toggle_default: False + .. toggle_description: Enable this feature to allow this Open edX platform to be an + OAuth2 authentication provider. This is necessary to enable some other features, + such as the REST API for the mobile application. + .. toggle_category: admin + .. toggle_use_cases: monitored_rollout + .. toggle_creation_date: 2014-09-09 + .. toggle_expiration_date: None + .. toggle_status: supported + .. toggle_warnings: None + """ 'ENABLE_OAUTH2_PROVIDER': False, # Allows to enable an API endpoint to serve XBlock view, used for example by external applications.