search

DINA-Web / guidelines

Guidelines on how to create, test and deploy modules within the DINA-project
2 stars 1 forks source link

Discussion about version in the URI #8

Open Inkimar opened 8 years ago

Inkimar commented 8 years ago

The document states the following ::

" Versioning of the API SHOULD be driven by significant changes in the endpoint logic, i.e. changes in the request or response structure.

The API SHOULD use version numbers that are easy to read and maintain, i.e. v1, v2, v3 for major versions and v1_1, v1_2_3 for minor versions."

More text is needed to explain the the significance of the first,second and third position in the versioning, as "v1 to v2 breaks backwards compatibility" , "v1.2 to v1.2.1 is a bug-fix"

I cannot find any standardization on the pattern. Would we want to have

  1. The pattern that is suggested, using an underscore : v1_1 and v_1_2_3 or
  2. or would we like to have a pattern with a dash instead ? : v1-1 and v-1-2-3
caalle commented 8 years ago

Should the guidelines alse use sem.ver?