update api change log for 2018-12-08
closes: CORE-2191 test plan: - view api change log and verify updates for 2018-12-08 heading and table - verify included links work correctly Change-Id: I2984727048ff3d741de7764e3898f6d6bbb1a957 Reviewed-on: https://gerrit.instructure.com/173168 Reviewed-by: Mysti Sadler <mysti@instructure.com> Tested-by: Jenkins QA-Review: Pedro Fajardo <pfajardo@instructure.com> Product-Review: Erin Hallmark <erin@instructure.com>
This commit is contained in:
Erin Hallmark
parent
78d6218d4d
commit
6fd5aed3ed
|
|
@ -4,9 +4,47 @@ API Change Log
|
|||
The API Change Log includes adjustments to the Canvas API documentation as part of each Canvas release. This change log can be updated at any time. Instructure may add, change, and deprecate API elements according to the timelines indicated in the <a href="https://www.canvaslms.com/policies/api-policy">Canvas API Policy page</a>.
|
||||
|
||||
<ul><li>For a summary of all deprecations, view the <a href="file.breaking.html">breaking changes API page</a>.</li>
|
||||
<li>This page documents API changes for the last four releases. For prior releases, view the <a href="file.changelog_archive.html">API Change Log archive page</a>.</li>
|
||||
<li>This page documents API changes for the last four releases. The release date indicates the date that the API code will be available in the production environment. For prior releases, view the <a href="file.changelog_archive.html">API Change Log archive page</a>.</li>
|
||||
</ul>
|
||||
|
||||
<h2>2018-12-08</h2>
|
||||
|
||||
<h3>Changes</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Calls</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="sis_imports.html">SIS Imports API</a></td>
|
||||
<td>Abort SIS Import Endpoint<br><br>
|
||||
Get SIS Import List Endpoint</td>
|
||||
<td>Added clarification that aborting a sis batch can take time and subsequent sis batches begin to process 10 minutes after the abort.<br><br>
|
||||
Workflow_state parameter: added initializing, failed, restoring, partially_restored, and restored as allowed values</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3>Additions</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 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>
|
||||
</table>
|
||||
<p></p>
|
||||
|
||||
<h2>2018-11-17</h2>
|
||||
|
||||
<h3>Changes</h3>
|
||||
|
|
@ -127,101 +165,3 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
<td>Added LTI Course ID and Course ID return parameters</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h2>2018-10-06</h2>
|
||||
|
||||
<h3>Changes</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Calls</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="accounts.html">Accounts API</a></td>
|
||||
<td>Permissions Endpoint</td>
|
||||
<td>Added links to Course and Group permissions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="courses.html">Courses API</a></td>
|
||||
<td>Permissions Endpoint</td>
|
||||
<td>Added links to Account and Group permissions</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>Basics</th>
|
||||
<th>File</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="file.file_uploads.html">Uploading Files</td>
|
||||
<td>Uploading via URL</td>
|
||||
<td>Explains file management system transition and clarifies newer file upload process
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>OAuth2</th>
|
||||
<th>Endpoint</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="file.oauth_endpoints.html">OAuth2 Endpoints</td>
|
||||
<td>Get login/oauth2/auth</td>
|
||||
<td>Below parameters table, clarified info on scopes for oath2 endpoint
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3>Additions</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Calls</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
<tr>
|
||||
<td><a href="file.assignment_external_tools.html">Assignment External Tools</a></td>
|
||||
<td></td>
|
||||
<td>Added content page</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="groups.html">Groups API</a></td>
|
||||
<td>Permissions Endpoint</td>
|
||||
<td>Added endpoint
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Responses</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="courses.html">Courses API</a></td>
|
||||
<td>Course Object</td>
|
||||
<td>Added created_at parameter, which returns the date the course was created
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3>Removals</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>Basics</th>
|
||||
<th>File</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="file.file_uploads.html">Uploading Files</td>
|
||||
<td>Uploading via URL</td>
|
||||
<td>Explains file management system transition and identifies deprecated behavior
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -1,11 +1,108 @@
|
|||
API Change Log Archive
|
||||
================
|
||||
|
||||
The Change Log Archive page displays previous API changes in the <a href="file.changelog.html">API Change Log</a> older than the last four releases.
|
||||
The Change Log Archive page displays previous API changes in the <a href="file.changelog.html">API Change Log</a> older than the last four releases. The release date indicates the date that the API code was made available in the production environment.
|
||||
<p>
|
||||
|
||||
<h2>Prior Updates</h2>
|
||||
|
||||
<h2>2018-10-06</h2>
|
||||
|
||||
<h3>Changes</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Calls</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="accounts.html">Accounts API</a></td>
|
||||
<td>Permissions Endpoint</td>
|
||||
<td>Added links to Course and Group permissions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="courses.html">Courses API</a></td>
|
||||
<td>Permissions Endpoint</td>
|
||||
<td>Added links to Account and Group permissions</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>Basics</th>
|
||||
<th>File</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="file.file_uploads.html">Uploading Files</td>
|
||||
<td>Uploading via URL</td>
|
||||
<td>Explains file management system transition and clarifies newer file upload process
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>OAuth2</th>
|
||||
<th>Endpoint</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="file.oauth_endpoints.html">OAuth2 Endpoints</td>
|
||||
<td>Get login/oauth2/auth</td>
|
||||
<td>Below parameters table, clarified info on scopes for oath2 endpoint
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3>Additions</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Calls</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
<tr>
|
||||
<td><a href="file.assignment_external_tools.html">Assignment External Tools</a></td>
|
||||
<td></td>
|
||||
<td>Added content page</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="groups.html">Groups API</a></td>
|
||||
<td>Permissions Endpoint</td>
|
||||
<td>Added endpoint
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<p></p>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>API Responses</th>
|
||||
<th>Function</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="courses.html">Courses API</a></td>
|
||||
<td>Course Object</td>
|
||||
<td>Added created_at parameter, which returns the date the course was created
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3>Removals</h3>
|
||||
<table class="changelog">
|
||||
<tr>
|
||||
<th>Basics</th>
|
||||
<th>File</th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="file.file_uploads.html">Uploading Files</td>
|
||||
<td>Uploading via URL</td>
|
||||
<td>Explains file management system transition and identifies deprecated behavior
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2>2018-09-15</h2>
|
||||
|
||||
<h3>Additions</h3>
|
||||
|
|
|
|||
Loading…
Reference in New Issue