Governing APIs across an organisation requires consistent vocabulary. These exercises focus on the collocations API designers, platform engineers, and architects use when versioning, deprecating, and documenting APIs.
0 / 5 completed
1 / 5
The API team follows semantic versioning practices to ___ without breaking existing integrations.
Version an API is the standard API governance collocation for applying a versioning scheme to manage backward compatibility. 'Version' used as a verb is standard in API design documentation. 'Update' and 'change' describe the act of modifying; 'upgrade' implies quality improvement rather than compatibility management.
2 / 5
The team published a migration guide alongside the announcement to ___ that had been available since v1.
Deprecate endpoints is the formal API lifecycle collocation for signalling that an endpoint is being phased out. 'Deprecate' implies a warning period before removal. 'Remove' and 'retire' describe the final step; 'disable' implies immediate unavailability.
3 / 5
Consumer-driven contract testing was introduced to ___ between microservices.
Enforce contracts is the API governance collocation for ensuring that producers and consumers adhere to agreed interface definitions. 'Enforce' implies automated validation in the pipeline. 'Verify' and 'test' describe the checking process; 'check' is too informal.
4 / 5
The API governance board requires teams to ___ in the developer portal before any release.
Document changes is the standard API governance collocation for producing structured records of modifications in changelogs or OpenAPI specs. 'Document' implies a formal, structured artifact. 'Write' is generic; 'log' implies automated recording; 'record' is too neutral.
5 / 5
Consumers must be notified at least three months in advance to ___ on downstream clients.
Review breaking changes is the standard API collaboration collocation for formally examining modifications that alter existing behaviour. 'Review' implies a structured, cross-team evaluation. 'Check' is informal; 'assess' and 'analyse' focus on evaluation rather than the collaborative review process.