Edge Intelligence API

API Versioning

  • EI API will support versioning of API using URI path based versioning.
  • EI API will have the URI path /nbapi/ei/v1.
  • 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: Future releases may include backward compatible changes. When integrating, ensure your implementation can handle the addition of new fields, parameters, or API without breaking.

Next