API Versioning

  • EDM NB API will support versioning of API using URI path-based versioning.
  • EDM NB API will have the URI path /nbapi/edm/{version}.
  • API version is changed only for Breaking/Backward incompatible changes.
  • API version will not be changed when backward compatible changes are made.

Possible Backward Compatible Changes

  • Adding new attributes in the JSON output of existing API
  • Adding support for new query parameters
  • Adding new endpoints

NOTE: Backward compatible changes may be done in a future release. Implement their integrations in such a way that their integration will not break by adding of new fields/params/API.