diff --git a/cms/envs/common.py b/cms/envs/common.py index a01c425174..77e8fe161d 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -2241,6 +2241,12 @@ PARTNER_SUPPORT_EMAIL = '' # Affiliate cookie tracking AFFILIATE_COOKIE_NAME = 'dev_affiliate_id' +# API access management +API_ACCESS_MANAGER_EMAIL = 'api-access@example.com' +API_ACCESS_FROM_EMAIL = 'api-requests@example.com' +API_DOCUMENTATION_URL = 'https://course-catalog-api-guide.readthedocs.io/en/latest/' +AUTH_DOCUMENTATION_URL = 'https://course-catalog-api-guide.readthedocs.io/en/latest/authentication/index.html' + ############## Settings for Studio Context Sensitive Help ############## HELP_TOKENS_INI_FILE = REPO_ROOT / "cms" / "envs" / "help_tokens.ini" diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 63b4d3a0f0..98a9e49df7 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -2,8 +2,6 @@ swagger: '2.0' info: title: Open edX API description: APIs for access to Open edX information - contact: - email: oscm@edx.org version: v1 basePath: /api consumes: diff --git a/lms/envs/bok_choy.py b/lms/envs/bok_choy.py index e3b52f8932..9a39d4d8bb 100644 --- a/lms/envs/bok_choy.py +++ b/lms/envs/bok_choy.py @@ -140,6 +140,11 @@ if RELEASE_LINE == "master": 'course_author': 'https://edx.readthedocs.io/projects/edx-partner-course-staff', } +# API access management +API_ACCESS_MANAGER_EMAIL = 'api-access@example.com' +API_ACCESS_FROM_EMAIL = 'api-requests@example.com' +API_DOCUMENTATION_URL = 'https://course-catalog-api-guide.readthedocs.io/en/latest/' +AUTH_DOCUMENTATION_URL = 'https://course-catalog-api-guide.readthedocs.io/en/latest/authentication/index.html' ##################################################################### # Lastly, see if the developer has any local overrides. diff --git a/lms/envs/devstack.py b/lms/envs/devstack.py index e5967f4a1c..ca65998e1d 100644 --- a/lms/envs/devstack.py +++ b/lms/envs/devstack.py @@ -509,6 +509,12 @@ SUBSCRIPTIONS_LEARNER_HELP_CENTER_URL = None SUBSCRIPTIONS_BUY_SUBSCRIPTION_URL = f"{SUBSCRIPTIONS_ROOT_URL}/api/v1/stripe-subscribe/" SUBSCRIPTIONS_MANAGE_SUBSCRIPTION_URL = None +# API access management +API_ACCESS_MANAGER_EMAIL = 'api-access@example.com' +API_ACCESS_FROM_EMAIL = 'api-requests@example.com' +API_DOCUMENTATION_URL = 'https://course-catalog-api-guide.readthedocs.io/en/latest/' +AUTH_DOCUMENTATION_URL = 'https://course-catalog-api-guide.readthedocs.io/en/latest/authentication/index.html' + ################# New settings must go ABOVE this line ################# ######################################################################## # See if the developer has any local overrides. diff --git a/openedx/core/apidocs.py b/openedx/core/apidocs.py index 45a61a948d..0d96864c3d 100644 --- a/openedx/core/apidocs.py +++ b/openedx/core/apidocs.py @@ -2,6 +2,7 @@ Open API support. """ +from django.conf import settings from edx_api_doc_tools import make_api_info from rest_framework import serializers @@ -10,7 +11,7 @@ api_info = make_api_info( version="v1", description="APIs for access to Open edX information", #terms_of_service="https://www.google.com/policies/terms/", # TODO: Do we have these? - email="oscm@edx.org", + email=settings.API_ACCESS_MANAGER_EMAIL, #license=openapi.License(name="BSD License"), # TODO: What does this mean? )