I 31 Add idempotency to POST and PATCH operations - UnionInternationalCheminsdeFer/OSDM GitHub Wiki

I-31: Add Idempotency to POST and PATCH operations

Description

Add idempotency to POST and PATCH information to prevent resource duplicate or lost updates.

Owner

  • Ralf Bayer / Clemens Gantert (DB)
  • Klaus Kovar / Sabine Eder (öBB)
  • Johan Nieuwerth (Sqills)
  • Eliza Parmigani (Amadeus)
  • Andreas Schlapbach (SBB)

Business Value

For implementors

who design a OSDM integration

the idempotency property

is a quality of an API

that enforces consistency

unlike existing APIs

our solution reduces inconsistencies (duplicate or loss of updates).

Business Outcomes

The measurable benefits that the business can anticipate if the epic hypothesis is proven to be correct.

Less support effort due to inconsistency (no sync requests as in H/H).

Leading Indicators

The early measures that will help predict the business outcome hypothesis.

Allocator implementations support idempotency from the start.

Nonfunctional Requirements

Nonfunctional requirements (NFRs) associated with the epic.

The Idempotency-Key header approach shall be implemented.

Next Step

HOME WORK Become a idempotency experts:

Specification Effort: SMALL