Change Management

A Breaking Change in the API is any modification that can potentially break existing integration.

This requires API consumers to alter their existing code or configurations to maintain compatibility with the updated version.

Atto classifies the following as breaking changes:

• Changes to the API contract: Changing or removing existing endpoints, altering method signatures, or adding or changing required input parameters.
• Behavioral changes: Changing the data types, error handling mechanisms, or adding or updating validation rules.
• Deprecation of features: Removing or significantly altering existing features or functionality.
• Authorisation/Authentication modifications: Changing security requirements or access controls.

Any non-breaking or additive changes in the API refer to any modification that should not affect existing functionality or usage of the API for its consumers.

These changes are backward-compatible, meaning that they can be safely integrated into existing applications without requiring code modifications.

Atto classifies the following as non-breaking changes:

• Addition of new features: Introducing new endpoints, methods, optional parameters, headers or response fields to existing products.
• Non-disruptive enhancements: Performance improvements, refactoring, or internal changes that do not alter the external API contract.
• Bug fixes: Resolving issues or glitches that do not change the existing API behavior.
• Documentation updates: Improving or expanding the API documentation without changing the API itself.

Atto will inform consumers about breaking changes within a reasonable amount of time before deploying to Production.