API deprecation and sunset communication is a critical responsibility for platform teams — handled well, it builds trust with the developer community; handled poorly, it causes production failures and frustration. From alerting consumers and setting sunset dates to publishing migration guides and decommissioning endpoints, each phase has precise professional language. This exercise covers the collocations used in API versioning policies and platform engineering communications.
0 / 5 completed
1 / 5
The platform team published a deprecation notice to ___ all API consumers of the upcoming end-of-life for the v2 REST API.
Alert consumers is the standard API lifecycle communication collocation — deprecation notices 'alert' developers to upcoming breaking changes so they can plan migrations. 'Warn' implies danger or risk; 'tell' is informal; 'advise' implies recommendations. 'Alert' is the appropriate term for the proactive, formal communication of a time-sensitive change that requires consumer action.
2 / 5
The engineering team set a hard ___ date of March 31st after which all requests to v1 endpoints would return a 410 error.
Sunset date is the canonical API deprecation lifecycle collocation — the day on which deprecated APIs are decommissioned is called the 'sunset date'. 'Deadline' implies a task completion date; 'removal date' is technically accurate but less idiomatic; 'expiry' is used for licences and tokens. 'Sunset date' is the standard term in API versioning policies, developer portals, and platform engineering communications.
3 / 5
The developer portal team created a step-by-step guide to help consumers ___ their integrations from the v2 to the v3 API.
Migrate integrations is the standard API sunset communication collocation — consumer applications are 'migrated' from deprecated to current API versions through a structured process. 'Update' implies patching rather than restructuring; 'move' is informal; 'upgrade' implies improvement. 'Migrate' is the precise term for the planned process of moving an integration to a new API contract, with associated testing and validation.
4 / 5
The API team added a `Deprecation` response header to all v2 endpoints to ___ developers of the sunset timeline at the point of use.
Notify developers via headers is the precise API deprecation signalling collocation — HTTP `Deprecation` and `Sunset` headers are used to 'notify' consumers at the API level without requiring them to read documentation. 'Inform' and 'remind' are broader; 'warn' implies imminent danger. 'Notify' is the RFC 8594 standard term for signalling deprecation and sunset information through API response headers.
5 / 5
The platform team decided to ___ the legacy OAuth 1.0 endpoints six months after releasing the OAuth 2.0 replacement.
Decommission the endpoints is the formal infrastructure lifecycle collocation — APIs are 'decommissioned' when they are permanently taken out of service after their sunset date. 'Remove' and 'delete' describe code changes; 'disable' implies a temporary or reversible action. 'Decommission' is the precise term for the permanent retirement of an API from production infrastructure, including removing routing, monitoring, and documentation.