Find removed API endpoints before a release

Created by

yipee Gameplay

Actor

OpenAPI JSON Diff & Breaking Change Checker

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.

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 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

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 removed API endpoints before a release". Sign up or log in and you'll land in Apify Console with a copy of this exact task.

Start the "Find removed API endpoints before a 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 removed API endpoints before a 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 removed API endpoints before a release" task via API.