Go to example tasks
Find newly required API parameters before release
Created by
yipee Gameplay
Compare two synthetic OpenAPI JSON specs for an inventory API. Find two potential breaking changes: an optional warehouse query parameter becomes required, and a new required X-Client-Version header is added. Inspect locations and suggested actions in HTML, CSV or JSON. No API calls. Selected checks only, not a full compatibility guarantee. Displayed Actor pricing applies.
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 Inventory API",
"version": "1.0.0"
},
"paths": {
"/inventory": {
"get": {
"parameters": [
{
"name": "warehouse",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Inventory count",
"content": {
"application/json": {
"schema": {
"type": "integer"
}
}
}
}
}
}
}
}
}
Current OpenAPI JSON(required):{
"openapi": "3.1.2",
"info": {
"title": "Synthetic Inventory API",
"version": "2.0.0"
},
"paths": {
"/inventory": {
"get": {
"parameters": [
{
"name": "warehouse",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Client-Version",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Inventory 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.
