search

DoDCIO / eads

Enterprise APIs for Data Sharing (EADS)
https://dodcio.github.io/eads
Other
7 stars 2 forks source link

Creating Versions #89

Closed ostranme closed 7 years ago

ostranme commented 7 years ago

It might be helpful to provide a guideline for when to create a version for your API. In API development there are many ways to break compatibility and negatively impact your clients.

Suggesting to describe the factors to consider when you are trying to decide if a new version is appropriate or if a modification of an existing representation is sufficient and acceptable.

killerbgt commented 7 years ago

We already mention breaking changes in the Versioning section, but I'll add a bullet about modifying an existing version.