Briefle words · Code & architecture
Deprecation
Officially marking something as outdated and scheduled for removal while it still works, so users have time and a path to switch.
Say it to an AI
Renaming weight (kg) to weightGrams is a breaking change, so ship it under /v2 using URL-based API versioning and keep /v1 byte-for-byte unchanged. Add a v2 shipment serializer, and note the v1 deprecation date in the changelog.
How an expert would brief the stronger version of “Shipment API change”.
See it
Try it as a puzzle →A pull request changes a field in a logistics API that dozens of customer integrations call.
Why: A's changelog says v1 keeps 'weight' until 2027-03-31; B's changelog announces the change after it has already happened.
Related words
Room 5 · APIs & data
Learn “Deprecation” in a five-minute lesson