API design reviews require precise collocations. Practise the phrases engineers use when creating and governing API specifications.
0 / 5 completed
1 / 5
Fill in: 'The architect asked us to ___ the OpenAPI contract before implementation begins.'
We 'review a contract' — 'review' is the standard collocation for a structured technical examination of an API contract or specification. 'Check' is informal; 'read' implies passive consumption; 'inspect' suggests a more granular examination and is less common in API governance contexts.
2 / 5
Fill in: 'Removing the userId field from the response would ___ backward compatibility for all existing clients.'
We 'break backward compatibility' — 'break' is the dominant API-design collocation for introducing a change that prevents existing clients from working. 'Damage' is metaphorical; 'affect' is too neutral; 'violate' is used for policies or agreements, not compatibility.
3 / 5
Fill in: 'To avoid breaking changes, we should ___ the endpoint and add /v2 alongside the existing path.'
We 'version an endpoint' — 'version' used as a verb is the API-design standard for introducing a new iteration of an endpoint. 'Rename' changes only the name; 'update' is too generic; 'duplicate' creates a copy without the versioning intent.
4 / 5
Fill in: 'We plan to ___ the legacyToken field in the next minor release and remove it in v3.'
We 'deprecate a field' — 'deprecate' is the precise API lifecycle collocation for marking an element as obsolete while keeping it functional during a transition period. 'Remove' is the final step after deprecation; 'disable' implies switching off; 'hide' is not a standard API-design term.
5 / 5
Fill in: 'After every API release, engineers must ___ a changelog so consumers know what changed.'
We 'publish a changelog' — 'publish' is the standard collocation for making a changelog available to consumers in a formal, accessible way. 'Write a changelog' focuses on authoring; 'post a changelog' is informal; 'create a changelog' is about inception rather than distribution.