Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme for the user_api.

Browse Source
This commit is contained in:
Feanil Patel
2019-04-26 13:27:56 -04:00
parent 6a09385ea5
commit a774618853
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
openedx/core/djangoapps/user_api/README.rst Normal file
View File

@@ -0,0 +1,19 @@
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.
Direction: Decompose
===============
Currently this app is a catch all for many user related information even when that information sholud 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
==================