diff --git a/scripts/user_retirement/docs/implementation_overview.rst b/scripts/user_retirement/docs/implementation_overview.rst index b6cf1a5130..902732a441 100644 --- a/scripts/user_retirement/docs/implementation_overview.rst +++ b/scripts/user_retirement/docs/implementation_overview.rst @@ -53,15 +53,18 @@ the platform to handle the retirement of PII in custom or internal services that part of the standard Open edX installation but are crucial for specific deployments. Here is an example of how the ``EXTRA_SERVICES_TO_RETIRE_FROM`` setting can be configured: + .. code-block:: python - EXTRA_SERVICES_TO_RETIRE_FROM = [ + + EXTRA_SERVICES_TO_RETIRE_FROM = [ { 'name': 'MOCK_SERVICE', 'service_base_url': 'http://fake_service_base_url', 'retirement_url_path': 'fake_retirement_url_path' } - ] -This setting defines a list of services, each with a name, service_base_url, and retirement_url_path, + ] + +This setting defines a list of services, each with a ``name``, ``service_base_url``, and ``retirement_url_path``, allowing the user retirement process to include these additional services. This example state diagram outlines the pathways users follow throughout the diff --git a/scripts/user_retirement/docs/service_setup.rst b/scripts/user_retirement/docs/service_setup.rst index 366541a33a..58a0f41001 100644 --- a/scripts/user_retirement/docs/service_setup.rst +++ b/scripts/user_retirement/docs/service_setup.rst @@ -63,20 +63,24 @@ defining *derived* settings specific to Open edX. Read more about it in * - EXTRA_SERVICES_TO_RETIRE_FROM - None - A list of additional services from which user data should be retired. Each entry in the list should be a dictionary with the following keys: + - ``name``: The name of the service. - ``service_base_url``: The base URL of the service's API. - ``retirement_url_path``: The API path for the user retirement endpoint. - This setting allows the retirement process to interact with external services not covered by default. For example: - .. code-block:: python - EXTRA_SERVICES_TO_RETIRE_FROM = [ - { - 'name': 'MOCK_SERVICE', - 'service_base_url': 'http://fake_service_base_url', - 'retirement_url_path': 'fake_retirement_url_path' - }, - # Add more services as needed - ] - By default, this setting is empty, meaning no additional services are included. This can be overridden in `https://github.com/openedx/edx-platform/blob/master/lms/envs/common.py. + + This setting allows the retirement process to interact with external services not covered by default. For example: + + .. code-block:: python + + EXTRA_SERVICES_TO_RETIRE_FROM = [ + { + 'name': 'MOCK_SERVICE', + 'service_base_url': 'http://fake_service_base_url', + 'retirement_url_path': 'fake_retirement_url_path' + } + ] + + By default, this setting is empty, meaning no additional services are included. This can be overridden in `common.py `_. ================= diff --git a/scripts/user_retirement/requirements/base.txt b/scripts/user_retirement/requirements/base.txt index b0a649c675..f57f1dad43 100644 --- a/scripts/user_retirement/requirements/base.txt +++ b/scripts/user_retirement/requirements/base.txt @@ -534,7 +534,7 @@ edx-drf-extensions==10.3.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.23.4 +edx-enterprise==4.23.8 # via # -c scripts/user_retirement/requirements/../../../requirements/constraints.txt # -r scripts/user_retirement/requirements/../../../requirements/edx/base.txt diff --git a/scripts/user_retirement/requirements/testing.txt b/scripts/user_retirement/requirements/testing.txt index 3fb96783ca..6231b3bb36 100644 --- a/scripts/user_retirement/requirements/testing.txt +++ b/scripts/user_retirement/requirements/testing.txt @@ -526,7 +526,7 @@ edx-drf-extensions==10.3.0 # edx-when # edxval # openedx-learning -edx-enterprise==4.23.4 +edx-enterprise==4.23.8 # via -r scripts/user_retirement/requirements/base.txt edx-event-bus-kafka==5.8.1 # via -r scripts/user_retirement/requirements/base.txt