Final tweaks to API documentation updates

This commit is contained in:
Sylvia Pearce
2015-07-15 21:46:11 +00:00
parent d2b6ac84d3
commit c2420b0940
11 changed files with 62 additions and 58 deletions

View File

@@ -1,12 +1,13 @@
##################################################
Enrollment API
##################################################
###################################
Enrollment API Enrollment Resource
###################################
You can use the Enrollment API to complete the following tasks.
With the Enrollment API **Enrollment** resource, you can complete the
following tasks.
* :ref:`Get the user's enrollment status in a course <Get the Users Enrollment
Status in a Course>`.
* :ref:`Get enrollment details for a course<Get Enrollment Details for a
* :ref:`Get the user's enrollment information for a course<Get Enrollment Details for a
Course>`.
* :ref:`View a user's enrollments <View and add to a Users Course
Enrollments>`.
@@ -93,9 +94,9 @@ Get the User's Enrollment Information for a Course
.. _View and add to a Users Course Enrollments:
*********************************************
View and Add to a User's Course Enrollments
*********************************************
**********************************************************
View a User's Enrollments or Enroll a User in a Course
**********************************************************
.. autoclass:: enrollment.views.EnrollmentListView

View File

@@ -34,7 +34,7 @@ The Enrollment API supports the following tasks, methods, and endpoints.
<Get the Users Enrollment Status in a Course>`
- GET
- /api/enrollment/v1/enrollment/{user_id},{course_id}
* - :ref:`Get enrollment details for a course
* - :ref:`Get the user's enrollment information for a course
<Get Enrollment Details for a Course>`
- GET
- /api/enrollment/v1/course/{course_id}