Find newly required API parameters before release

Created by

yipee Gameplay

Actor

OpenAPI JSON Diff & Breaking Change Checker

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.

Try for free

OpenAPI JSON Diff & Breaking Change Checkerfluffy_ingot/openapi-change-preflight

Review status

Findings

Previous operations

Current operations

+2 fields

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

How it works

Sign up on Apify or log in

The OpenAPI JSON Diff & Breaking Change Checker Actor is ready to run with the inputs already set for "Find newly required API parameters before release". Sign up or log in and you'll land in Apify Console with a copy of this exact task.

Start the "Find newly required API parameters before release" task

The OpenAPI JSON Diff & Breaking Change Checker Actor will start running based on the input automatically. You can also change all the input fields, like previous openapi json and current openapi json, to match your specific use case.

Receive the "Find newly required API parameters before release" output

Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as review status, findings, previous operations, and more.

Integrate into your workflow

The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also run the "Find newly required API parameters before release" task via API.