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

Add documentation for is_active and profile_image

Browse Source
This commit is contained in:
Daniel Friedman
2015-03-17 11:53:33 -04:00
committed by Andy Armstrong
parent e710a5b2d0
commit 4125bf96d6
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
openedx/core/djangoapps/user_api/accounts/views.py
View File

@@ -82,22 +82,23 @@ class AccountView(APIView):
* bio: null or textural representation of user biographical
information ("about me").
* profile_image: a dict with the following keys describing
* is_active: boolean representation of whether a user is active.
* profile_image: JSON representation of a user's profile image
information. The keys are:
the user's profile image:
* "has_image": true if the user has a profile image
* "image_url_full": an absolute URL to the user's full
profile image
* "image_url_large": an absolute URL to a large thumbnail
of the profile image
* "image_url_medium": an absolute URL to a medium thumbnail
of the profile image
* "image_url_small": an absolute URL to a small thumbnail
of the profile image
* "has_image": boolean indicating whether the user has
a profile image.
* "image_url_*": absolute URL to various sizes of a user's
profile image, where '*' matches a representation of
the corresponding image size such as 'small', 'medium',
'large', and 'full'. These are configurable via
PROFILE_IMAGE_SIZES_MAP.
* requires_parental_consent: true if the user is a minor
requiring parental consent.
> For all text fields, clients rendering the values should take care
For all text fields, clients rendering the values should take care
to HTML escape them to avoid script injections, as the data is
stored exactly as specified. The intention is that plain text is
supported, not HTML.