edx-platform

Files

Eugene Dyudyunov 8bd43207ca refactor!: switch from LegacyWaffle* to modern waffles (#30330 )

This is a first stage for removing the LegacyWaffle* classes.

LegacyWaffleFlag usage replaced with WaffleFlag;
LegacyWaffleSwitche usage replaced with WaffleSwitch;
New CourseWaffleFlag added to the temporary module __future__ as FutureCourseWaffleFlag;
Updated all the imports to use CourseWaffleFlag from the __future__ module;

BREAKING CHANGE: A number of toggle related constants (e.g. ENABLE_ACCESSIBILITY_POLICY_PAGE)
changed types. They were strings, and are now toggle instances (e.g. WaffleSwitch). Although the entire
refactor should be self-contained in edx-platform, if any plugins or dependencies were directly
using these constants, they will break. If this is the case, try to find a better publicized way of
exposing those toggles.

2022-05-05 12:03:10 -04:00

accounts

refactor!: switch from LegacyWaffle* to modern waffles (#30330 )

2022-05-05 12:03:10 -04:00

course_tag

fix: add a couple guards for anonymous users

2021-12-09 10:26:51 -05:00

management

chore: Applied lint-amnesty on openedx/core/djangoapps

2021-12-09 13:39:45 +05:00

migrations

refactor: Ran pyupgrade on openedx/core/djangoapps/user_api

2021-04-01 19:34:01 +05:00

preferences

chore: Applied lint-amnesty on openedx/core/djangoapps

2021-12-09 13:39:45 +05:00

templates/user_api/edx_ace/deletionnotificationmessage/email

Fix edx-ace templates

2019-07-25 12:51:05 +05:00

tests

chore: Applied lint-amnesty on openedx/core/djangoapps

2021-12-09 13:39:45 +05:00

verification_api

feat: provide new verification details endpoint for support-tools (#30004 )

2022-03-03 10:33:14 -05:00

__init__.py

…

admin.py

fix: fixed django4 warnings (#29643 )

2022-03-04 15:03:02 +05:00

errors.py

refactor: Ran pyupgrade on openedx/core/djangoapps/user_api

2021-04-01 19:34:01 +05:00

helpers.py

fix: fixed django4 warnings (#29643 )

2022-03-04 15:03:02 +05:00

legacy_urls.py

fix: fixed django4 warnings (#29643 )

2022-03-04 15:03:02 +05:00

message_types.py

refactor: Ran pyupgrade on openedx/core/djangoapps/user_api

2021-04-01 19:34:01 +05:00

middleware.py

Use full names for common.djangoapps imports; warn when using old style (#25477 )

2020-11-10 07:02:01 -05:00

models.py

refactor: use value for filtering indexed boolean field

2021-10-07 16:06:58 +05:00

partition_schemes.py

chore: Applied lint-amnesty on openedx/core/djangoapps

2021-12-09 13:39:45 +05:00

permissions.py

BOM-2329: Applied pylint-amnesty to system_wide_roles, theming, user_api, user_authn

2021-02-04 18:00:51 +05:00

README.rst

update READMEs to clarify responsibilities

2019-12-16 13:51:43 -05:00

rules.py

Run 2to3 -f future . -w

2019-12-30 10:35:30 -05:00

serializers.py

Refactor: Removed unused imports

2021-04-06 18:25:35 +05:00

urls.py

fix: fixed django4 warnings (#29644 )

2022-03-07 15:50:17 +05:00

views.py

Refactor: Removed unused imports

2021-04-06 18:25:35 +05:00

README.rst

Status: Active

Responsibilities
================
The user_api app is currently a catch all that is used to provide various apis that are related to the user and also to features within the platform.

Intended responsibility: To manage user profile and general account information and to provide APIs to do so easily. This includes the following features: user preference, user profile, user retirement, and account activation/deactivation.

Direction: Decompose
===============
Currently this app is a catch all for many user related information even when that information should really belong in a different app.  If you are building a feature and need to provide information about a user within the context of your feature, you should localize that API to your feature and make your assumptions about what user information you need clear.

For example authentication related APIs have already been moved to the user_authn django app.

Glossary
========

More Documentation
==================