Web APIs: Enriched DX By Disallowing Unknown Fields

Brandur Leach · 5 May 2024

Brandur Leach did not write this page.

Every claim below was made in this piece, quoted word for word and numbered in the order the piece makes them, so you can read it there rather than take our word for it. The sentence above each quote is our reading of the claim, not their wording. Each quote was checked against a stored copy of the page at build time; where the two differ, the quote is the fact.

Our reading
Rejecting unknown fields in API requests is easy to implement and, on the day it is needed, saves hours of time and frustration.

Their wordsIt's a feature that's not needed every day, but it's easy to implement, and the day it is, it'll save hours worth of time and frustration.
Our reading
Webhook receiving endpoints are a common place where unknown fields in the payload should not be rejected.

Their wordsA common place where DisallowUnknownFields should not be applied are webhook receive endpoints.

Keep reading

The other pieces are the ones whose claims are worded most like this one's. That measures language, not agreement: they may argue the opposite.