Skip to content
Snippets Groups Projects

API deprecation process

Last edited by Chad Leong

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 osdu/platform/system/storage#62 (closed)
    • 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
  3. Mark API as “To be deprecated” in API docs for X milestones until fix is available
  4. Remove API in agreed milestone.
  5. 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

Comments

    Please register or sign in to add a comment.