User guide
API Comparison
Compare the EDA OpenAPI specs of two releases, path by path and schema by schema.
API Comparison (/openapi-comparison) shows how the EDA REST API changed between a source and
a target release.
Using it
- In the compare bar, choose the source and target releases (
?sr=...&tr=...in the URL; a link with both runs the comparison on load), then press Compare. - Summary tiles count the APIs added, removed and changed, and the operations and schemas that changed inside them.
- Filter by status or text, swap the direction, and open an API to see its endpoint changes,
marked
+added,−removed and changed. Copy share link copies the comparison's URL.
When two releases have no API changes, the page says so and offers to list the unchanged APIs.
Statuses
| Status | Meaning |
|---|---|
| Added | The API exists only in the target release |
| Removed | The API exists only in the source release |
| Modified | Paths or schema content changed |
| Unchanged | Same content in both (a change of version string alone still counts as unchanged) |
How it works
flowchart LR
MS["Source OpenAPI manifest"] --> D["Diff the two manifests"]
MT["Target OpenAPI manifest"] --> D
D --> FAM["Group specs by API family"]
FAM --> BOTH{"In both releases?"}
BOTH -->|"no"| AR["Added or removed"]
BOTH -->|"yes"| LOAD["Load both specs, 6 at a time"]
LOAD --> CMP["Compare paths and schemas"]
CMP --> ST["Modified or shared"]
Each spec download gives up after 30 seconds and is tried once more. An API whose specs still don't load is shown as Error and the rest of the comparison carries on; the progress bar counts every spec as it finishes.