mkauffman

REST API Deprecation Process

Blog Post created by mkauffman on Oct 22, 2018

We've had questions come in regarding REST API v1 deprecation. The answers to these questions inline below:

 

 

   When it comes to V1 route deprecation what will be process of notifying the V1 route consumers?

 

   - What will be the notification process?

 

Deprecation of REST APIs take place only when a new version is released - the deprecation is noted on the API documentation page: https://developer.blackboard.com/portal/displayApi

 

 

   - How long will it take to completely remove once notified? 

 

Removal of deprecated REST APIs from product will take place minimally* one year after deprecation is noted in the API documentation.

*In extremely rare cases this removal may take place sooner than one year - if that is the case it will be noted in the above noted documentation.

 

 

   - Will the V1 routes be removed from existing BB Learn instance versions?

 

Deprecated APIs will continue to work with releases prior to the Learn version from which they are removed.

 

E.G.: API is deprecated in 3300.0 and removed in 3400.0 - the deprecated API will continue to work with all supported Learn versions prior to 3400.0.

 

   - If not, from which Blackboard instance version upwards will V1 routes be removed and when is it scheduled?

 

 

See above.

Outcomes