Skip to content
HALOWERK

Codewerk

openapi breaking diff

Combines openapi-diff 0.24.1 (set-based comparison of paths, methods, JSON request and response body schemas, response status codes and response headers) with own rules for what openapi-diff does not cover: parameters (new required, became required, removed, type and enum changes), requestBody.required and operation security requirements. Rules follow the common classification also used by oasdiff (github.com/oasdiff/oasdiff): narrowing what clients may send or widening what servers may.

POST https://code.halowerk.com/v1/openapi-breaking-diff

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
baseSee schemaYesThe previous (released) API description as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.
revisionSee schemaYesThe new API description as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "base",
    "revision"
  ],
  "properties": {
    "base": {
      "description": "The previous (released) API description as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 2000000
        }
      ]
    },
    "revision": {
      "description": "The new API description as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 2000000
        }
      ]
    }
  }
}

Open original schema

Published input example

{
  "base": {
    "openapi": "3.0.3",
    "info": {
      "title": "Pets",
      "version": "1.0.0"
    },
    "paths": {
      "/pets": {
        "get": {
          "responses": {
            "200": {
              "description": "ok"
            }
          }
        }
      }
    }
  },
  "revision": {
    "openapi": "3.0.3",
    "info": {
      "title": "Pets",
      "version": "2.0.0"
    },
    "paths": {}
  }
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’