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

Fix misleading enrollment API documentation

Browse Source 
The user parameter corresponds to the username, not the user ID.
This commit is contained in:
Bertrand Marron
2015-06-20 00:43:32 +02:00
parent f07e4b9b38
commit e0ed2d8a3a
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
common/djangoapps/enrollment/views.py
View File

@@ -266,7 +266,7 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn):
**Post Parameters**
* user: The user ID of the currently logged in user. Optional. You cannot use the command to enroll a different user.
* user: The username of the currently logged in user. Optional. You cannot use the command to enroll a different user.
* mode: The Course Mode for the enrollment. Individual users cannot upgrade their enrollment mode from
'honor'. Only server-to-server requests can enroll with other modes. Optional.
@@ -316,7 +316,7 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn):
* invite_only: Whether students must be invited to enroll in the course; true or false.
* user: The ID of the user.
* user: The username of the user.
"""
authentication_classes = OAuth2AuthenticationAllowInactiveUser, EnrollmentCrossDomainSessionAuth