Skip to content
GitLab
Explore
Sign in
Register
This is an archived project. Repository and other project resources are read-only.
OSDU Software
Documentation
Wiki
API deprecation process
API deprecation process
· Changes
Page history
Create API deprecation process
authored
Jun 29, 2022
by
Chad Leong
Hide whitespace changes
Inline
Side-by-side
API-deprecation-process.md
0 → 100644
View page @
ce48aef3
## DRAFT
OSDU is working on a longer-term maturation process but for now, this will be the short-term official guideline for the deprecation process:
1.
Make an ADR – An example https://community.opengroup.org/osdu/platform/system/storage/-/issues/62
-
Ensure all CSPs/services lead are aware of the API deprecation/changes
2.
Communicate and agree on timeline for fix on dependencies for X milestones
-
Announce intent in release notes/related channels for community awareness for X milestones
4.
Mark API as “To be deprecated” in API docs for X milestones until fix is available
5.
Remove API in agreed milestone.
6.
If no other services dependencies or objections in ADR, we aim for at least 1 milestone cycle.
Example scenario:
-
ADR approved/Announce intent for upcoming milestone in current M11 cycle
-
Mark API as deprecated in M12
-
Deprecate API in M13