Commit Graph
7 Commits
Author SHA1 Message Date
Sree Vardhan VandClaude Opus 5.5 73810b86ef Add webhook reliability to API Design "Webhooks vs Polling" topic (#10439)
Tighten the comparison and add what receivers need to handle in practice:
at-least-once and out-of-order delivery, signature verification (HMAC with
a shared secret), acknowledging quickly and processing in the background,
deduplicating by event ID, and combining webhooks with polling to catch
missed events.

Add the Standard Webhooks spec and GitHub's webhook best-practice and
signature-validation guides as resources.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 10:32:02 +02:00
Sree Vardhan VandClaude Opus 5.5 8f6dab39e8 Explain idempotency keys in API Design "Idempotency" topic (#10438)
The topic said idempotency "sometimes" applies to POST but did not explain
how. Clarify which HTTP methods are idempotent by definition and describe
idempotency keys, the common way to make POST/PATCH safe to retry:
client-generated unique key, stored result replayed on repeats, reuse with
a different payload rejected, keys expire.

Add MDN, the IETF Idempotency-Key header draft and Stripe's reference
implementation as resources.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 10:31:03 +02:00
Sree Vardhan VandClaude Opus 5.5 ac8ddd654c Improve "Error Handling / Retries" in API Design roadmap (#10437)
Rewrite the topic copy to reflect current practice: retry only transient
failures (timeouts, 429, 502-504), cap retries, use exponential backoff
with jitter, respect Retry-After, and retry only idempotent requests.
The old copy suggested retrying until a request succeeds, which can cause
retry storms.

Add three resources on backoff, jitter and Retry-After. No other topic in
the API Design, Backend or AI Engineer roadmaps covers these yet.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 10:30:18 +02:00
younggglcy 468065609f fix(api-design): correct resource modeling title (#10265) 2026-09-03 10:20:14 +02:00
github-actions[bot]andnilbuild 470acb367d chore: sync content to repo (#10242)
Co-authored-by: nilbuild <4921183+nilbuild@users.noreply.github.com>
2026-08-18 13:55:55 +02:00
Mohammad Ahmer Malick 621b8478da fix: correct typos and improve clarity in various documentation files (#10235) 2026-08-14 18:59:55 +02:00
Arik Chakma 274082fd77 feat: clean roadmap content and sync scripts (#10181)
* refactor: clean to roadmap content

* refactor: move shared helpers into scripts/lib
2026-07-28 05:45:17 +06:00