api-guidelines icon indicating copy to clipboard operation
api-guidelines copied to clipboard

[update] relax "MUST change type context attribute to indicate incompatible changes" to allow deprecation cycle on property basis

Open BirgitBader opened this issue 2 years ago • 1 comments

(i) This issue has been manually transferred from a former internal repository, as a private repository issue cannot be transferred to a public repository.

Context

Currently, API providers are enforced to introduce a new event type whenever incompatible changes are made.

The following alternative approach should be allowed too:

  1. Add a new property
  2. Communicate the planned deprecation with all parties and settle on a sunset date
  3. Deprecating the old property with the specific sunset date
  4. Removing the old property after sunset date, making sure that no consumer uses the old property beforehand.

The advantage of this approach is that no additional versions need to be maintained. The disadvantage is that one can not use the Galapagos subscription model to verify that no consumer uses an old schema version before sunsetting it.

BirgitBader avatar May 16 '23 07:05 BirgitBader

Comment history

Jul 8, 2022 by @thake

This issue has been extracted from feedback by @christianfinckler1212. @otto-ec/async-group Any thoughts on this proposed alternative way to handle incompatible changes?

BirgitBader avatar May 16 '23 07:05 BirgitBader