update enrollments api documentation

clarify that only root account admins can use it to see
other user's enrollments

closes #ADMIN-334

Change-Id: Id0c66c9518f29ca77e2eeb96aff7416df9540518
Reviewed-on: https://gerrit.instructure.com/131329
Tested-by: Jenkins
Reviewed-by: Jeremy Stanley <jeremy@instructure.com>
Product-Review: James Williams  <jamesw@instructure.com>
QA-Review: James Williams  <jamesw@instructure.com>
This commit is contained in:
James Williams 2017-10-31 10:48:12 -06:00
parent cbd6afaee4
commit 9cbe432041
1 changed files with 1 additions and 1 deletions

View File

@ -276,7 +276,7 @@ class EnrollmentsApiController < ApplicationController
# and a student or in multiple course sections), each enrollment will be # and a student or in multiple course sections), each enrollment will be
# listed separately. # listed separately.
# #
# note: Currently, only an admin user can return other users' enrollments. A # note: Currently, only a root level admin user can return other users' enrollments. A
# user can, however, return his/her own enrollments. # user can, however, return his/her own enrollments.
# #
# @argument type[] [String] # @argument type[] [String]