Commit e0ed2d8a by Bertrand Marron

Fix misleading enrollment API documentation

The user parameter corresponds to the username, not the user ID.
parent f07e4b9b
...@@ -266,7 +266,7 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn): ...@@ -266,7 +266,7 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn):
**Post Parameters** **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 * 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. 'honor'. Only server-to-server requests can enroll with other modes. Optional.
...@@ -316,7 +316,7 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn): ...@@ -316,7 +316,7 @@ class EnrollmentListView(APIView, ApiKeyPermissionMixIn):
* invite_only: Whether students must be invited to enroll in the course; true or false. * 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 authentication_classes = OAuth2AuthenticationAllowInactiveUser, EnrollmentCrossDomainSessionAuth
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment