API versioning

API Versioning Plan

On the moment of login, the Application tells Open Console which protocol version was used for the implementation. The server will reply its version as well, for informational purpose. Those versions do not need to match. That's pretty unusual for interfaces, which is a pitty.

A version string looks, as in common practice, like this:

      major . minor . patch

For instance, version 1.2.3 has as major 1, as minor 2, and as patch-level 3.

Promises:

• all patch levels are fully interchangeable: both backwards as forward compatible;
• for a minor number increment, backwards compatibility is preserved. Fields can get added or extended, without breaking the existing implementations; and
• when the major changes, then you need to expect a real porting effort.

In most cases, the Open Console implementation is able to match the Application version dynamically.