simplify table css, fix page titles
Change CSS table entries to use '~' instead of '+' so we don't have
to repeat the empty 'div' before each table. We only need one.
Use alternate method of indicating Header1 style in markdown to fix
the title of the page. Our post processor included the '#' from
the first line in the page title.
test plan: titles don't start with '#'
tables look the same
Change-Id: Ie73b91e1628dc22112b46ed6442eea7860062aad
Reviewed-on: https://gerrit.instructure.com/178090
Tested-by: Jenkins
Reviewed-by: Tucker Mcknight <tmcknight@instructure.com>
QA-Review: Erin Hallmark <erin@instructure.com>
Product-Review: Erin Hallmark <erin@instructure.com>
This commit is contained in:
Robert Lamb
parent
7de0f76588
commit
cde840ff54
|
|
@ -1,14 +1,14 @@
|
|||
# Breaking Changes
|
||||
Breaking Changes
|
||||
================
|
||||
|
||||
The breaking changes page displays a comprehensive list of all deprecations noted in the [API Change Log](file.changelog.html).
|
||||
|
||||
Instructure may deprecate API elements according to the timelines indicated in the [Canvas API Policy page](https://www.canvaslms.com/policies/api-policy).
|
||||
|
||||
<div class="changelog"></div>
|
||||
## Removals
|
||||
|
||||
### 2018-10-06
|
||||
<div class="changelog"></div>
|
||||
|
||||
| API | File | Change | Removal Date |
|
||||
| --- | --- | --- | --- |
|
||||
| [Uploading Files](file.file_uploads.html) | Uploading via POST process | Step 3: Identifies deprecated behavior in replacing GET calls with the deprecated POST request | 2019-04-21 |
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
# API Change Log
|
||||
API Change Log
|
||||
==============
|
||||
|
||||
### What is the 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 [Canvas API Policy page](https://www.canvaslms.com/policies/api-policy).
|
||||
|
|
@ -8,10 +9,10 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
- For a summary of all deprecations, view the [breaking changes API page](file.breaking.html).
|
||||
- This page documents API changes for the last four releases. For prior releases, view the [API Change Log archive page](file.changelog_archive.html).
|
||||
|
||||
<div class="changelog"></div>
|
||||
## 2019-01-26
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|----------------------|----------------------|--------------------------|
|
||||
| [Submissions API] | List Gradeable Students endpoint | Added clarification about anonymous grading |
|
||||
|
|
@ -19,7 +20,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Submissions API]: submissions.html
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|----------------------|----------------------|--------------------------|
|
||||
| [Assignments API] | Assignment Object | Returns grader_count, ginal_grader, grader_comments_visible_to_graders, graders_anonymous_to_graders, grader_names_visible_to_final_grader, and anonymous_grading parameters |
|
||||
|
|
@ -31,7 +31,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Users API]: users.html
|
||||
|
||||
### Removals
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|----------------------|----------------------|--------------------------|
|
||||
| [Enrollments API] | Enrollment Object | Removed computed_current_score, computed_final_score, computed_current_grade, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters |
|
||||
|
|
@ -41,7 +40,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
## 2019-01-05
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|----------------------|----------------------|--------------------------|
|
||||
| [Developer Keys API] | | Verified and corrected all links in document |
|
||||
|
|
@ -51,7 +49,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Files API]: files.html
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|------------|-----------|-----------|
|
||||
| [Assignments API] | Create an Assignment Endpoint<br><br>Edit an Assignment Endpoint | Added assignment\[allowed\_attempts\] parameter |
|
||||
|
|
@ -65,7 +62,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Roles API]: roles.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|-------------------|------------|---|
|
||||
| [Assignments API] | Assignment Object | Added allowed\_attempts parameter |
|
||||
|
|
@ -81,7 +77,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
|
||||
|
||||
### Removals
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|---------------|-----------|---|
|
||||
| [Courses API] | List Users in Course Endpoint | Include parameter: Removed email as an optional parameter |
|
||||
|
|
@ -89,7 +84,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Courses API]: courses.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| Content | Function | |
|
||||
|---------------|----------|---|
|
||||
| [Navigation Tools] | | Removed incorrect auto-generated links from page |
|
||||
|
|
@ -99,7 +93,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
## 2018-12-08
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-------------------|----------|---|
|
||||
| [SIS Imports API] | Abort SIS Import Endpoint<br><br> Get SIS Import List Endpoint | 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 |
|
||||
|
|
@ -107,7 +100,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[SIS Imports API]: sis_imports.html
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-------------------------|-----------------------------------|---|
|
||||
| [SIS Import Errors API] | SISImportError Object | Added row\_info parameter, which displays the contents of the line that had the error |
|
||||
|
|
@ -117,7 +109,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Users API]: users.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|---------------|----------------------------|---|
|
||||
| [Courses API] | List Your Courses Endpoint | Include parameter: Added graded period parameters to be returned even if total grades are hidden in the course |
|
||||
|
|
@ -128,7 +119,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
## 2018-11-17
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-------------|----------------------------|-----|
|
||||
| [Roles API] | Create a New Role Endpoint | Permissions parameter: Updated account- and course-level role names to match roles in the Canvas Permissions page |
|
||||
|
|
@ -136,7 +126,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Roles API]: roles.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|-------------------|---------------------------------|---|
|
||||
| [Assignments API] | List Assignments Endpoint | Clarified that the paginated list of assignments is returned for the current course or assignment group |
|
||||
|
|
@ -146,7 +135,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[Rubrics API]: rubrics.html
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|------------------------------|---------------------------------------|----|
|
||||
| [LTI Variable Substitutions] | com.instructure.Person.name\_sortable | Added variable that returns the sortable name of the launching user. Availability is when launched by a logged in user |
|
||||
|
|
@ -154,7 +142,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[LTI Variable Substitutions]: file.tools_variable_substitutions.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|-------------------|-----------------------------------------------|---|
|
||||
| [SIS Imports API] | Get the Current Importing SIS Import Endpoint | Added endpoint to return the SIS imports that are currently processing for an account |
|
||||
|
|
@ -162,7 +149,6 @@ The API Change Log includes adjustments to the Canvas API documentation as part
|
|||
[SIS Imports API]: sis_imports.html
|
||||
|
||||
### Removals
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|---------------|----------|------------------------------------------------------------|
|
||||
| [Planner API] | | Removed the beta warning banner from the API documentation |
|
||||
|
|
|
|||
|
|
@ -1,13 +1,14 @@
|
|||
# API Change Log Archive
|
||||
API Change Log Archive
|
||||
======================
|
||||
|
||||
The Change Log Archive page displays previous API changes in the [API Change Log](file.changelog.html) older than the last four releases.
|
||||
|
||||
The release date indicates the date that the API code was made available in the production environment.
|
||||
|
||||
<div class="changelog"></div>
|
||||
## 2018-10-27
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|------------------------|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Conversations API] | Create a Conversation Endpoint | Recipients parameter: Added clarification when the course/group has over 100 enrollments, bulk\_message and group\_conversation must be set to true |
|
||||
|
|
@ -20,7 +21,6 @@ The release date indicates the date that the API code was made available in the
|
|||
|
||||
<p></p>
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|-------------------------------------------------|----------------------|-----------------------------------------------------|
|
||||
| [Plagiarism Detection Platform Assignments API] | LtiAssignment Object | Added LTI Course ID and Course ID return parameters |
|
||||
|
|
@ -32,7 +32,6 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-10-06
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|----------------|----------------------|----------------------------------------------|
|
||||
| [Accounts API] | Permissions Endpoint | Added links to Course and Group permissions |
|
||||
|
|
@ -43,14 +42,12 @@ The release date indicates the date that the API code was made available in the
|
|||
|
||||
<p></p>
|
||||
|
||||
<div class="changelog"></div>
|
||||
| Basics | File | |
|
||||
|-----------------|--------------------|--------------------------------------------------------------------------------------------|
|
||||
| Uploading Files | Uploading via POST | Step 3: Explains file management system transition and clarifies newer file upload process |
|
||||
|
||||
<p></p>
|
||||
|
||||
<div class="changelog"></div>
|
||||
| OAuth2 | Endpoint | |
|
||||
|------------------|-----------------------|---------------------------------------------------------------------|
|
||||
| OAuth2 Endpoints | Get login/oauth2/auth | Below parameters table, clarified info on scopes for oath2 endpoint |
|
||||
|
|
@ -58,7 +55,6 @@ The release date indicates the date that the API code was made available in the
|
|||
<p></p>
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-----------------------------|----------------------|--------------------|
|
||||
| [Assignment External Tools] | | Added content page |
|
||||
|
|
@ -68,7 +64,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[Groups API]: groups.html
|
||||
<p></p>
|
||||
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|---------------|---------------|----------------------------------------------------------------------------|
|
||||
| [Courses API] | Course Object | Added created\_at parameter, which returns the date the course was created |
|
||||
|
|
@ -76,7 +71,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[Courses API]: courses.html
|
||||
|
||||
### Removals
|
||||
<div class="changelog"></div>
|
||||
| API | File | |
|
||||
|-----------------|--------------------|--------------------------------------------------------------------------------------------------------------------------|
|
||||
| Uploading Files | Uploading via POST | Step 3: Identifies deprecated behavior in replacing GET calls with the deprecated POST request, to be removed 2019-04-21 |
|
||||
|
|
@ -84,7 +78,6 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-09-15
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|--------------------------------|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Custom Gradebook Columns API] | Bulk Update Column Data | Sets the content of custom columns |
|
||||
|
|
@ -96,7 +89,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[SIS Imports API]: sis_imports.html
|
||||
<p></p>
|
||||
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|-------------------------|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Accounts API] | Get Help Links Endpoint | Returns the help links for that account |
|
||||
|
|
@ -108,7 +100,6 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-08-04
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-----------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Outcome Results API] | Get Outcome Result Rollups | Aggregate parameter: Clarified that the median is a separate parameter |
|
||||
|
|
@ -116,7 +107,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[Outcome Results API]: Outcome_results.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| CSV Format | File | |
|
||||
|-----------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Outcomes Data Format] | outcomes.csv | Vendor_guid field: Clarified that vendor_guid IDs will prefix “canvas_outcome:” and “canvas_outcome_group:” for outcomes and groups, respectively. In addition, these prefixes are reserved; newly created outcomes and groups may not have vendor_guid fields with these prefixes. |
|
||||
|
|
@ -125,7 +115,6 @@ The release date indicates the date that the API code was made available in the
|
|||
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-----------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Outcome Results API] | Get Outcome Result Rollups | Exclude parameter: Specified additional values to exclude. “Missing\_user\_rollups” excludes rollups for users without results. <br><br>Aggregate\_stat parameter: If aggregate rollups requested, then this value determines what statistic is used for the aggregate. Defaults to “mean” if this value is not specified. |
|
||||
|
|
@ -135,13 +124,11 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-07-14
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|------------------------------------|----------|----------------------------------------------------------------------------------------------------------------|
|
||||
| Plagiarism Detection Platform APIs | | In the API page sidebar, moved all API documentation for the plagiarism platform to the External Tools section |
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|---------------------------|----------|-----------|
|
||||
| [API Token Scopes] | | Added API |
|
||||
|
|
@ -154,14 +141,12 @@ The release date indicates the date that the API code was made available in the
|
|||
|
||||
### Changes
|
||||
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-------------|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Users API] | Get a Pandata JWT Token and its Expiration Date endpoint | Changed endpoint to reflect use for current user only (/api/v1/users/self/pandata\_token) <br><br>Clarified description in that endpoint is currently only available to the mobile developer keys |
|
||||
|
||||
<p></p>
|
||||
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|---------------|-------------|-------------------------------------------------------------------------------------------------------------------|
|
||||
| [Files API] | File Object | Updated file object example and ordering; object returns uuid, folder\_id, display\_name, and modified\_at fields |
|
||||
|
|
@ -170,7 +155,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[Files API]: files.html
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-------------------|------------------------------------------------|---------------------------------|
|
||||
| [SIS Imports API] | Restore workflow\_states of SIS imported items | Restore states for sis\_imports |
|
||||
|
|
@ -182,7 +166,6 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-06-02
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
|
||||
| API Calls | Function | |
|
||||
|---------------------------------|----------------------------------|------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
|
@ -201,7 +184,6 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-05-12
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|----------------------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Accounts API] | List Active Courses in an Account endpoint | sort parameter: replaced *subaccount* value with *account\_name* value. Subaccount can still be used as a value for backward compatibility. |
|
||||
|
|
@ -211,7 +193,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[User Observees API]: user_observees.html
|
||||
|
||||
### Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|------------------------------|------------------------------------------------------------------------------------------------|----------------------------------------------|
|
||||
| [Accounts API] | List Active Courses in an Account endpoint | Include parameter: Added account\_name value |
|
||||
|
|
@ -233,7 +214,6 @@ The release date indicates the date that the API code was made available in the
|
|||
## 2018-04-21
|
||||
|
||||
### Changes
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|----------------|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Courses API] | Permissions endpoint | Includes link to Accounts API Permissions endpoint <br><br>Clarifies that permission names are documented in the Create a Role endpoint |
|
||||
|
|
@ -243,7 +223,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[Sections API]: sections.html
|
||||
|
||||
###Additions
|
||||
<div class="changelog"></div>
|
||||
| API Calls | Function | |
|
||||
|-------------------------|-------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
|
||||
| [Accounts API] | Permissions endpoint | New endpoint: GET /api/v1/accounts/:account\_id/permissions |
|
||||
|
|
@ -259,7 +238,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[Users API]: users.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| API Responses | Function | |
|
||||
|-------------------------|------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Modules API] | Module object <br><br>ModuleItem SequenceNode object <br><br>ModuleItemSequence object | Returns the published parameter <br><br>Returns the mastery\_path parameter and includes examples for the current and next items in the course <br><br>Returns full examples for items and modules arrays |
|
||||
|
|
@ -271,7 +249,6 @@ The release date indicates the date that the API code was made available in the
|
|||
[SIS Imports API]: sis_imports.html
|
||||
|
||||
<p></p>
|
||||
<div class="changelog"></div>
|
||||
| CSV Format | File | |
|
||||
|------------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [SIS CSV Format] | changes\_sis\_id.csv | Added group\_category as a type <br><br>old\_integration\_id field: description clarifies that this field does not support group categories <br><br>new\_integration\_id field: description clarifies that this field does not support group categories |
|
||||
|
|
|
|||
|
|
@ -196,12 +196,12 @@ table th, table td {
|
|||
padding: 4px;
|
||||
}
|
||||
|
||||
.changelog+table {
|
||||
.changelog~table {
|
||||
border: 2px solid gray;
|
||||
width: 100%
|
||||
}
|
||||
|
||||
.changelog+table th {
|
||||
.changelog~table th {
|
||||
padding: 4px;
|
||||
border: 1px inset gray;
|
||||
border-spacing: 1px;
|
||||
|
|
@ -213,19 +213,19 @@ table th, table td {
|
|||
background-color: #DDD;
|
||||
}
|
||||
|
||||
.changelog+table tr td:nth-child(1) {
|
||||
.changelog~table tr td:nth-child(1) {
|
||||
width:20%;
|
||||
}
|
||||
|
||||
.changelog+table tr td:nth-child(2) {
|
||||
.changelog~table tr td:nth-child(2) {
|
||||
width:30%;
|
||||
}
|
||||
|
||||
.changelog+table tr td:last-child {
|
||||
.changelog~table tr td:last-child {
|
||||
width:auto;
|
||||
}
|
||||
|
||||
.changelog+table td {
|
||||
.changelog~table td {
|
||||
padding: 10px 8px 10px 5px;
|
||||
border: 1px inset gray;
|
||||
border-spacing: 1px;
|
||||
|
|
|
|||
Loading…
Reference in New Issue