ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update API Change Log for ADMIN ticket omissions 

Closes: CORE-2262

Test plan:
- run bundle exec rake doc:api
- in 2019-01-05 log, view entry for users api
- in 2018-12-08 log, view entry for courses api

Change-Id: I223c47fa98f3e63466e596a3bfba8b6cb5990b82
Reviewed-on: https://gerrit.instructure.com/175524
Tested-by: Jenkins
Reviewed-by: James Williams <jamesw@instructure.com>
QA-Review: Erin Hallmark <erin@instructure.com>
Product-Review: Erin Hallmark <erin@instructure.com>
This commit is contained in:
Erin Hallmark 2018-12-14 08:17:50 -07:00
parent 07b074e16e
commit 948f6741c7
1 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/api/changelog.md
View File

@ -98,6 +98,19 @@ The API Change Log includes adjustments to the Canvas API documentation as part
</table>
<h3>Removals</h3>
<table class="changelog"
<tr>
<th>API Calls</th>
<th>Function</th>
<th></th>
</tr>
<tr>
<td><a href="courses.html">Courses API</a></td>
<td>List Users in Course Endpoint</td>
<td>Include parameter: Removed email as an optional parameter</td>
</tr>
</table>
<p></p>
<table class="changelog">
<tr>
<th>Content</th>
@ -137,15 +150,27 @@ Workflow_state parameter: added initializing, failed, restoring, partially_resto
<th></th>
</tr>
<tr>
<td><a href="courses.html">Courses API</a></td>
<td>List Your Courses Endpoint</td>
<td>Include parameter: Added graded period parameters to be returned even if total grades are hidden in the course</td>
</tr>
<tr>
<td><a href="sis_import_errors.html">SIS Import Errors API</a></td>
<td>SISImportError Object</td>
<td>Added row_info parameter, which displays the contents of the line that had the error</td>
</tr>
<tr>
<td><a href="users.html">Users API</a></td>
<td>List the Activity Stream Endpoint</td>
<td>Added only_active_courses parameter</td>
</tr>
</table>
<p></p>
<table class="changelog">
<tr>
<th>API Responses</th>
<th>Function</th>
<th></th>
<tr>
<td><a href="courses.html">Courses API</a></td>
<td>List Your Courses Endpoint</td>
<td>Include parameter: Added graded period parameters to be returned even if total grades are hidden in the course</td>
</tr>
</table>
<p></p>
@ -161,7 +186,7 @@ Workflow_state parameter: added initializing, failed, restoring, partially_resto
<tr>
<td><a href="roles.html">Roles API</a></td>
<td>Create a New Role Endpoint</td>
<td>Permissions parameter: Updated account- and course-level roles to match roles in the Canvas Permissions page
<td>Permissions parameter: Updated account- and course-level role names to match roles in the Canvas Permissions page
</tr>
</table>
<p></p>