Expand and Contract
Add a compatible new form, migrate callers, then retire the old form. Set the migration window from consumer needs and the rollback commitment.
-
-
API Gateway
A gateway checks that the token is valid and the quota is not spent. Which invoices belong to whom is a question its backend should answer.
-
Idempotency Key
Reuse a durable operation key within the provider’s retention window. A recovered response may still leave the business outcome unresolved.
-
Problem Details
A client matching on your error message has built a dependency on your copywriting. The type URI exists so it does not have to.
-
Breaking Change
A change can break the supported contract or expose an unsupported assumption. Check both, including changes that silently alter results.
-
API Contracts, Compatibility, and Retirement
API changes need both a clear compatibility contract and evidence of consumer impact. Errors, retry safety, and retirement are part of that work.
-
Token Bucket
A token bucket admits requests while it has tokens and refills at a constant rate, so capacity sets the largest burst and the refill rate sets the long-run average.
-
Designing Platform APIs and Extension Boundaries
Portals, pipelines, and extensions all call the platform API. This article covers its lifecycle, tenancy, idempotency, extension permissions, and how to change it compatibly.