Bierman RESTCONF backward Compatibility

Owned by gaurav.agrawal
Last updated: Jun 08, 2022
1 min read



The Bierman internet draft version of the RESTCONF API spec has been deprecated in the ODL Sulfur release and will be removed in the following release (Chlorine).  It is likely that  some of our clients will be slow to migrate to the RFC 8040 API due to resource limitations.  Therefore, we are exploring the following options to provide backward compatibility:

  1. We could take over the current OpenDaylight karaf feature code for the Bierman style interface and support that as a new repository in CCSDK.

  2. We could implement a new microservice to translate the Bierman API to RFC 8040 API.



Analysis is captured in below attachments



Option 1: Take ODL Restconf Bierman code in CCSDK

Advantage: Minimal Efforts

Issue: ODL License is EPL and is different with ONAP License (Apache 2.0)



Option 2: New mS for Translation

Advantage: No licensing problem

Issue: Efforts to develop translator will be much more. Also there are chances to miss out some specific border scenarios during translation.



Next Step

  1. Look for a solution to the licensing issue as required by option 1 considering it requires much less effort and handles all scenarios.

  2. Community to decide on a specific Solution option. Also related grey areas for that solution option to be discussed with the ODL community.