Canvas API Change Log FAQ

Document created by Erin Hallmark Administrator on Nov 11, 2019
Version 1Show Document
  • View in full screen mode

What is the API Change Log?

The API Change Log includes adjustments to the Canvas API documentation as part of each Canvas release or deploy. 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.

 

What do the heading dates mean in the Change Log?

The heading date indicates the date that the API code adjustment will be deployed to the production environment. However, included adjustments are available for testing using the Canvas beta environment. All API links note the code as available in the beta environment Canvas API documentation.

 

What do the different entries mean in the Change Log?

The Change Log can include four different entries: additions, changes, deprecations, and removals.

 

  • Additions: An API, endpoint, parameter, or other element has been added to the API. Additions do not affect any existing functionality and can be implemented by developers at any time.
  • Changes: An API has received a non-functional change such as adding a description to an API, parameter, or endpoint, or revising content to clarify functionality.
  • Deprecations: An API, endpoint, parameter, or value has been deprecated. Developers should discontinue use and replace it with new functionality before the removal date, which is included in the notice. Deprecations are also known as breaking changes, which also displayed in the Canvas API Breaking Changes page.
  • Removals:
    • An API, endpoint, parameter, or value that was previously announced as deprecated has been removed (most common entry use)
    • An optional parameter or value has been removed
    • Another type of minor removal has been made that does not affect users for a deprecation announcement per Canvas API Policy

 

How often is the Change Log updated?

The Change Log is updated for any release or deploy that includes API additions, changes, deprecations, or removals. The heading date indicates the date the adjustments will be made in the production environment.

 

How do I subscribe to the API Change Log?

You can subscribe to this document by following the content via the Actions menu. To learn how to follow content, see How do I follow people, places, or content in the Canvas Community?

 

How do I find out about breaking API changes?

Breaking changes are included in the Canvas API Change Log, first as a deprecation and then as a removal. However, you can view all breaking changes in Canvas API Breaking Changes. You can also subscribe to this document by following the content via the Actions menu. To learn how to follow content, see How do I follow people, places, or content in the Canvas Community?

 

How do I see past entries to the API Change Log?

You can see all previous API adjustments in the 2019 API Change Log Archive and 2018 API Change Log Archive.

 

What if I need help with APIs?

We have several resources to help you get started! A good place to start is the Canvas Developers user group, full of Canvas advocates who are waiting to help you with your questions.

1 person found this helpful

Attachments

    Outcomes