OpenAPI Breaking Change Detector
Pricing
$0.15 / successfully completed comparison
Compare OpenAPI 3.0 contracts with directional request/response rules, breaking-change evidence, JSON/CSV and summary reports. No endpoint probes. $0.15 per successful comparison.
You can access the OpenAPI Breaking Change Detector programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
# Set API token$API_TOKEN=<YOUR_API_TOKEN>
# Prepare Actor input$cat > input.json << 'EOF'<{< "oldSpec": "{\n \"openapi\": \"3.0.3\",\n \"info\": {\n \"title\": \"Order API\",\n \"version\": \"1.0\"\n },\n \"paths\": {\n \"/orders/{id}\": {\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"path\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"get\": {\n \"responses\": {\n \"200\": {\n \"description\": \"OK\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"status\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\",\n \"paid\"\n ]\n }\n }\n }\n }\n }\n }\n }\n },\n \"post\": {\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"status\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\",\n \"paid\"\n ]\n }\n }\n }\n }\n }\n },\n \"responses\": {\n \"204\": {\n \"description\": \"Updated\"\n }\n }\n }\n }\n }\n}",< "newSpec": "{\n \"openapi\": \"3.0.3\",\n \"info\": {\n \"title\": \"Order API\",\n \"version\": \"2.0\"\n },\n \"paths\": {\n \"/orders/{id}\": {\n \"parameters\": [\n {\n \"name\": \"id\",\n \"in\": \"path\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ],\n \"get\": {\n \"responses\": {\n \"200\": {\n \"description\": \"OK\",\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"id\",\n \"status\"\n ],\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\",\n \"paid\",\n \"refunded\"\n ]\n }\n }\n }\n }\n }\n }\n },\n \"parameters\": [\n {\n \"name\": \"X-Tenant\",\n \"in\": \"header\",\n \"required\": true,\n \"schema\": {\n \"type\": \"string\"\n }\n }\n ]\n },\n \"post\": {\n \"requestBody\": {\n \"required\": true,\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"required\": [\n \"status\"\n ],\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"enum\": [\n \"open\"\n ]\n }\n }\n }\n }\n }\n },\n \"responses\": {\n \"202\": {\n \"description\": \"Queued\"\n }\n }\n }\n },\n \"/health\": {\n \"get\": {\n \"responses\": {\n \"200\": {\n \"description\": \"Healthy\"\n }\n }\n }\n }\n }\n}",< "severityFilter": [< "high",< "warning",< "info"< ]<}<EOF
# Run the Actor using an HTTP API# See the full API reference at https://docs.apify.com/api/v2$curl "https://api.apify.com/v2/actors/afkdigital~openapi-breaking-change-detector/runs?token=$API_TOKEN" \< -X POST \< -d @input.json \< -H 'Content-Type: application/json'Below, you can find a list of relevant HTTP API endpoints for calling the OpenAPI Breaking Change Detector Actor. For this, you’ll need an Apify account. Replace <YOUR_API_TOKEN> in the URLs with your Apify API token, which you can find under API & Integrations in Apify Console. For details, see the API reference.
https://api.apify.com/v2/actors/afkdigital~openapi-breaking-change-detector/runs?token=<YOUR_API_TOKEN>Note: By adding the method=POST query parameter, this API endpoint can be called using a GET request and thus used in third-party webhooks. Please refer to our Run Actor API documentation.
https://api.apify.com/v2/actors/afkdigital~openapi-breaking-change-detector/run-sync-get-dataset-items?token=<YOUR_API_TOKEN>Note: This endpoint supports both POST and GET request methods. However, only the POST method allows you to pass input data. For more information, please refer to our Run Actor synchronously and get dataset items API documentation.
https://api.apify.com/v2/actors/afkdigital~openapi-breaking-change-detector?token=<YOUR_API_TOKEN>For more information, please refer to our Get Actor API documentation.
Actors can be used to scrape web pages, extract data, or automate browser tasks. Use the OpenAPI Breaking Change Detector API programmatically via the Apify API.
You can choose from:
You can start OpenAPI Breaking Change Detector with the Apify API by sending an HTTP POST request to the Run Actorendpoint. An Actor’s input and its content type can be passed as a payload of the POST request, and additional options can be specified using URL query parameters. The OpenAPI Breaking Change Detector is identified within the API by its ID, which is the creator’s username and the name of the Actor.
When the OpenAPI Breaking Change Detector run finishes you can list the data from its default dataset(storage) via the API or you can preview the data directly on Apify Console.