API changes · API Change Guard
Property / field removed
- Default severity
- Critical
- Finding code:
- API_BREAKING_FIELD_REMOVED
- Engine version:
- 2.2.0
What this finding means
API Change Guard reports this finding with the default severity “Critical”.
About the engine: OData, SOAP, RFC compatibility & deprecation impact scanner
How to fix it
Keep the property (mark deprecated) until all consumers stop reading it, or version the API.
How ERP Preflight detects it
The analysis is deterministic: the same exported files and the same knowledge snapshot always produce the same findings. No SAP system connection is required — you upload exports.
- Engine
- API Change Guard
- Accepted formats
- JSON, XML, TEXT
- What to export
Two API specifications of the same service — baseline (current) and candidate (target release): OpenAPI 2/3 (JSON or YAML) or OData EDMX V2/V4 XML — supplied as {'baseline': …, 'candidate': …} in raw_content / configuration or as artifacts named *baseline* / *candidate*; optional 'integrations' registry for consumer impact.
- Required input
- baseline specification
- candidate specification
- Evidence
- Each finding points to the artifact path, line and column, the code snippet and the SHA-256 of the uploaded file. Findings without such a pointer are demoted to confidence UNKNOWN.
- Confidence
- Each finding names the knowledge it relies on (Knowledge-graph API lifecycle snapshot (configuration.api_lifecycle)) and is capped by that source’s verification status.
- Knowledge sources
- Knowledge-graph API lifecycle snapshot (configuration.api_lifecycle) — verified against the official source
- Target releases of the engine
- S4H_2022, S4H_2023, S4HANA_CLOUD_2402, S4HANA_CLOUD_2408
Related findings
- CriticalEndpoint removed
- CriticalOData entity type removed
- CriticalOData entity set removed
- CriticalOData entity key changed
- CriticalOperation removed
- CriticalSecurity scheme or requirement changed