Stereotype «BreakingChange»
Stereotype «BreakingChange» can be used to mark model elements that are a breaking change compared to a previous version from a client / consumer perspective.
This is especially useful when you are working with semantic versioning approach. Using this stereotype you can then mark elements that break backward compatibility.
Example: a new request property is introduced and after a transition phase it will be mandatory.
JEAF Generator supports a so called breaking changes report that lists all the breaking changes.
| Stereotype | «BreakingChange» |
|
|---|---|---|
| Applicable Elements | NamedElement |
|
| Tagged Values | ||
| Name | Type | Description |
description |
String |
Description of an upcoming breaking change. |
since |
String |
Information since when a breaking change was announced for a model element e.g. a concrete version or date. |
activeWith |
String |
Version or date when a breaking change becomes active. Example: - A new parameter is introduced for a request. To not immediately break the API at first the parameter is optional. Using this field it can be defined when the parameter will be mandatory. |
activationDate |
String |
Explicit date when the breaking change will be activated. The expected date format is yyyy-mm-dd. |
Generated by JEAF Generator