Go to example tasks
Find removed API endpoints before a release
Created by
yipee Gameplay
Compare two synthetic Orders API specifications before a release. This example flags a removed endpoint, a newly required query parameter and a narrowed enum. It returns three potential-breaking findings in HTML, CSV and JSON. Selected checks only; compatibility is not established.
OpenAPI JSON Diff & Breaking Change Checkerfluffy_ingot/openapi-change-preflight
Review status
Findings
Previous operations
Current operations
+2 fieldsTextNumberBooleanListObject
Input
Previous OpenAPI JSON(required):{
"openapi": "3.1.2",
"info": {
"title": "Synthetic Orders API",
"version": "1.0"
},
"paths": {
"/orders": {
"get": {
"parameters": [
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"open",
"closed"
]
}
}
],
"responses": {
"200": {
"description": "Order count",
"content": {
"application/json": {
"schema": {
"type": "integer"
}
}
}
}
}
}
},
"/legacy": {
"get": {
"responses": {
"200": {
"description": "Legacy"
}
}
}
}
}
}
Current OpenAPI JSON(required):{
"openapi": "3.1.2",
"info": {
"title": "Synthetic Orders API",
"version": "2.0"
},
"paths": {
"/orders": {
"get": {
"parameters": [
{
"name": "state",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"open"
]
}
}
],
"responses": {
"200": {
"description": "Order count",
"content": {
"application/json": {
"schema": {
"type": "integer"
}
}
}
}
}
}
}
}
}
Output fields
Review status
Findings
Previous operations
Current operations
Details truncated
Compatibility established
Sign up on Apify01
Create your Apify account to access the OpenAPI JSON Diff & Breaking Change Checker.
Start the run02
The Actor will start running based on the input automatically.
Receive the output03
Monitor the progress in real-time. You will be notified as soon as your dataset is complete and ready for review.
Integrate into your workflow04
The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow.
