API Versioning

[rogocof]

As a developer,
I want to ensure a stable API,
so that (breaking) changes are documented and can be considered properly.

Hints / Details

We have, especially on the frontend side, serious problems when breaking changes are introduced. A stable API would be highly appreciated to be more productive and less blocked. I know that semantic versioning and versioning in general is a global issue, which was addressed already. However, is there the possibility to do at least some kind of API versioning for the traceability-foss project as a first step?

Acceptance Criteria

• Any kind of versioning to identify breaking changes on the endpoint side

Out of Scope

• General versioning approach
• Application versioning (this issue is only about API versions)

[ds-lcapellino]

Dear @rogocof,
thank you for creating this issue.
We at Trace-X use semantic versioning for our application. So in case of a Major version update (e.g. from 9.x.x to 10.x.x) we introduced breaking changes to our API. This should not be the case for Minor or Patch releases.
Information about what exactly changed can be seen in the CHANGELOG.MD.

I hope this helps.
If not, please create a discussion and/or join our open meetings: [TRACE-X] Trace-X Open Meeting