-
Notifications
You must be signed in to change notification settings - Fork 2
Home
Sven edited this page Dec 14, 2017
·
32 revisions
- Python / JavaScript API:
- Breaking changes are okay
- User decides update time
- Web API:
- Breaking changes only after deprecation period
- Service provider decides update time, user needs time to make adjustments
Assume that micro introduces a new announcement feature with the following API:
- type
Announcement
- Attribute
Application.announcements
- DB key
announcements
- endpoint
/api/announcements
- page
/announcements
- ...
If an existing micro application already makes use of any of those names, this could lead to breaking behavior (e.g. micro code modifies Application.announcements
or posts to /api/announcements
and they have different, unexpected semantics).
How can we solve this? New features that involve the extendable API could be major releases. New features could be introduced behind a feature toggle with a minor release and enabled by default with a major release. DB keys could be prefixed with micro
.
Rules that may be worth considering:
- multiline-comment-style (ESLint 4.9)