Integration
SAP API breaking changes and deprecations (OData, OpenAPI)
API Change Guard compares two specifications of the same service — the current baseline and the candidate of the target release — and classifies every difference as breaking or not.
Detected by:API Change Guard
Documented problems
- CriticalEndpoint removed
API_BREAKING_ENDPOINT_REMOVED
- CriticalOData entity type removed
API_BREAKING_ENTITY_REMOVED
- CriticalOData entity set removed
API_BREAKING_ENTITYSET_REMOVED
- CriticalProperty / field removed
API_BREAKING_FIELD_REMOVED
- CriticalOData entity key changed
API_BREAKING_KEY_CHANGED
- CriticalOperation removed
API_BREAKING_OPERATION_REMOVED
- CriticalSecurity scheme or requirement changed
API_BREAKING_SECURITY_CHANGED
- CriticalIncompatible type change
API_BREAKING_TYPE_CHANGED
- MajorEnum values removed
API_BREAKING_ENUM_RESTRICTED
- MajorType format changed
API_BREAKING_FORMAT_CHANGED
- MajorMaximum length decreased
API_BREAKING_MAX_LENGTH_DECREASED
- MajorOData navigation property removed
API_BREAKING_NAVIGATION_REMOVED
- MajorRequest parameter removed
API_BREAKING_PARAM_REMOVED
- MajorRequired request parameter renamed
API_BREAKING_PARAM_RENAMED
- MajorProperty renamed
API_BREAKING_PROPERTY_RENAMED
- MajorNew required parameter
API_BREAKING_REQUIRED_PARAM_ADDED
- MajorNew required property
API_BREAKING_REQUIRED_PROPERTY_ADDED
- MajorResponse property removed
API_BREAKING_RESPONSE_PROPERTY_REMOVED
- MajorResponse status code removed
API_BREAKING_RESPONSE_STATUS_REMOVED
- MajorRegistered consumption not defined in the baseline specification
API_COVERAGE_GAP_UNRESOLVED_CONSUMPTION
- MajorBreaking impact on an integration without a covering client test
API_COVERAGE_GAP_UNTESTED_IMPACT
- MinorElement marked deprecated
API_DEPRECATION_WARNING
- MinorAPI retired in the knowledge snapshot — successor available
API_SUCCESSOR_AVAILABLE
Informational findings
These findings confirm a good state or document a change. They are listed for completeness and are not problems.
- InfoEndpoint added
API_NON_BREAKING_ENDPOINT_ADDED
- InfoEnum values added
API_NON_BREAKING_ENUM_EXPANDED
- InfoMaximum length increased
API_NON_BREAKING_MAX_LENGTH_INCREASED
- InfoOperation added
API_NON_BREAKING_OPERATION_ADDED
- InfoOptional property added
API_NON_BREAKING_OPTIONAL_PROPERTY_ADDED
Terms used in this area
ERP Preflight is independent and not affiliated with SAP SE. SAP, ABAP, Fiori and S/4HANA are trademarks of SAP SE.