otto-de / otto-de/api-guidelines

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

Open
#22 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
50
Forks
16
PR merge metrics
No merged PRs in 30d

Description

(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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the guideline that requires a new event type for incompatible changes and compare it with the proposed property-level deprecation cycle. Done means the guideline clearly permits the alternative, including communication, a sunset date, and removal after consumers have migrated.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.