Master the precise word combinations used when discussing API versioning, deprecation, and migration in English. These collocations appear in API documentation, migration guides, and engineering discussions.
0 / 5 completed
1 / 5
We plan to ___ the v1 endpoints next quarter, giving clients six months to migrate to v2.
We 'deprecate endpoints' in API lifecycle language. 'Deprecate' is the technical term for marking something as outdated and scheduled for removal. 'Retire' is also used (slightly more final-sounding). 'Cancel' and 'remove' are too abrupt and do not convey the warning period implied by deprecation.
2 / 5
The team decided to ___ a breaking change under a new major version rather than modifying the existing API.
We 'introduce a breaking change' in API versioning. 'Introduce' is the standard verb for adding something new that changes behaviour: introduce a change, introduce a feature, introduce a constraint. 'Add a breaking change' is also common and natural in team discussions.
3 / 5
Clients should ___ to the latest version before the deprecation deadline to avoid service disruption.
We 'migrate to a new version' in API and infrastructure language. 'Migrate' implies a formal, planned transition of data or integration. 'Upgrade' is also used and focuses on improving version number. 'Update' is more casual; 'move to a version' is understandable but less technical.
4 / 5
To maintain backward compatibility, we added a ___ layer that translates v1 requests to the v2 format internally.
A 'shim' is the standard technical term for a compatibility layer that translates between API versions. 'Shim layer' or just 'shim' is used in API engineering to describe backward-compatible adapters. 'Bridge' and 'translation layer' are descriptive alternatives but 'shim' is the canonical term.
5 / 5
We need to ___ the migration guide before publishing the v3 release notes so developers have time to prepare.
We 'publish a migration guide' in technical documentation language. 'Publish' is the standard verb for making official documentation available: publish a guide, publish release notes, publish a changelog. 'Release' collocates more with software; 'share' is more informal and suggests a smaller audience.