Page 1 of 1

Interface compatibility

Posted: Thu Jun 22, 2023 11:28 am
by Bernd Welter
From what I see in the current documentation the API is in an early stage (v 0.x) as of today (July 2023).

How about the compatibility of interfaces? Could an integrator use an existing versioned API as long as we maintain that API version?
I assume that this is motivated by the xServer2 approach of so-caled versioned APIs

Bernd

Re: Interface compatibility

Posted: Thu Sep 05, 2024 12:52 pm
by Bernd Welter
I triggered this thread long before RouteOptimization Optiflow has been released.

As of today the version is 1.4.2 and I just want to use this to drop a statement about the versioning in general (also described in the faq's):
  • A change from 1.x to 1.y means
    • You do not have to update the client classess because this update is backwards compatible
    • Only if you want to benfit from a new feature (green) you have to update the client classes
  • A change from 1.x.y to 1.x.z means
    • You do not have to update the client classess because this update is backwards compatible
    • To benefit from the changes (yellow) you don't even have to update the client classes