Decision taken on 24.10.2024

Breaking changes include:

• Removing an entire operation
• Removing or renaming a parameter
• Removing or renaming a response field
• Adding a new required parameter
• Changing HTTP response code
• Making a previously optional parameter required
• Changing the type of a parameter or response field
• Removing enum values
• Adding a new validation rule to an existing parameter
• Changing authentication or authorization requirements

Non breaking changes include:

• Adding new parameters
• Adding new endpoints
• Error syntax/message changes/error code
• Endpoint, parameter description change (in the specs)
• Adding previously not documented detail (e.g. response code) to the Open API specification
• Reorganization/restructure of Open API specification not changing API behaviour

Parameters are defined as - headers, query parameters, path parameters, payload fields