52 lines
1.8 KiB
Python
52 lines
1.8 KiB
Python
"""
|
|
MFE API Views for useful information related to mfes.
|
|
"""
|
|
|
|
from django.conf import settings
|
|
from django.http import HttpResponseNotFound, JsonResponse
|
|
from django.utils.decorators import method_decorator
|
|
from django.views.decorators.cache import cache_page
|
|
from rest_framework import status
|
|
from rest_framework.views import APIView
|
|
|
|
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
|
|
|
|
|
|
class MFEConfigView(APIView):
|
|
"""
|
|
Provides an API endpoint to get the MFE_CONFIG from site configuration.
|
|
"""
|
|
|
|
@method_decorator(cache_page(settings.MFE_API_CONFIG_CACHE_TIMEOUT))
|
|
def get(self, request):
|
|
"""
|
|
GET /api/mfe/v1/config
|
|
or
|
|
GET /api/mfe/v1/config?mfe=name_of_mfe
|
|
|
|
**GET Response Values**
|
|
```
|
|
{
|
|
"BASE_URL": "https://name_of_mfe.example.com",
|
|
"LANGUAGE_PREFERENCE_COOKIE_NAME": "example-language-preference",
|
|
"CREDENTIALS_BASE_URL": "https://credentials.example.com",
|
|
"DISCOVERY_API_BASE_URL": "https://discovery.example.com",
|
|
"LMS_BASE_URL": "https://courses.example.com",
|
|
"LOGIN_URL": "https://courses.example.com/login",
|
|
"LOGOUT_URL": "https://courses.example.com/logout",
|
|
"STUDIO_BASE_URL": "https://studio.example.com",
|
|
"LOGO_URL": "https://courses.example.com/logo.png"
|
|
}
|
|
```
|
|
"""
|
|
|
|
if not settings.ENABLE_MFE_API:
|
|
return HttpResponseNotFound()
|
|
|
|
mfe_config = configuration_helpers.get_value('MFE_CONFIG', {})
|
|
if request.query_params.get('mfe'):
|
|
mfe = str(request.query_params.get('mfe')).upper()
|
|
mfe_config.update(configuration_helpers.get_value(f'MFE_CONFIG_{mfe}', {}))
|
|
|
|
return JsonResponse(mfe_config, status=status.HTTP_200_OK)
|