From a7746188537efc709275f9a4f731760f15fbeefd Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Fri, 26 Apr 2019 13:27:56 -0400 Subject: [PATCH] Readme for the user_api. --- openedx/core/djangoapps/user_api/README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 openedx/core/djangoapps/user_api/README.rst diff --git a/openedx/core/djangoapps/user_api/README.rst b/openedx/core/djangoapps/user_api/README.rst new file mode 100644 index 0000000000..de1d000596 --- /dev/null +++ b/openedx/core/djangoapps/user_api/README.rst @@ -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 +==================