charinev / opnc

CharIN Open Plug&Charge Protocol (OPNC)
Creative Commons Attribution Share Alike 4.0 International
18 stars 8 forks source link

API versioning #8

Closed cpalbr closed 1 year ago

cpalbr commented 1 year ago

Jerome B. wrote the following comment in the word document:

The versioning on 1 digit is highly debatable. A semver like versioning on 3 digits would permit to introduce non breaking change while keeping the API mandatory idempotency.

How should the versioning of OPNC be designed?

steffenrhinow commented 1 year ago

my opinion: 2-3 digits for the further development. but first digit to show major braking changes which is used in the api/endpoint

cpalbr commented 1 year ago

Do we need 2 or 3 digits?

steffenrhinow commented 1 year ago

I would be for 2. less complex major - breaking change minor - backward compatible functions, optional parameters, descriptions

JMR-Gireve commented 1 year ago

Ok for 3 levels Major level -> Changes that impact implementation: Changes are needed in IS which implements OPNC Minor level -> Backward compatible functional changes. No changes are required in IS which implements OPNC (except for new features) Corrective -> No new features & No impact. Only (corrective) changes in definition, description

MKeCharIN commented 1 year ago

aligned in the group