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-diffInputs
| Field | Type | Required | Description |
|---|---|---|---|
| base | See schema | Yes | The previous (released) API description as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected. |
| revision | See schema | Yes | The 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
}
]
}
}
}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
- Codewerk0.003 USDC
action sha pin
POSThttps://code.halowerk.com/v1/action-sha-pinFinds every "uses: owner/repo[/path]@ref" in a GitHub Actions workflow, resolves tags (including annotated tags) and branches to the commit SHA with git ls-remote against github.com, and rewrites the line to "uses: owner/repo[/path]@<sha> #
- Codewerk0.003 USDC
actionlint
POSThttps://code.halowerk.com/v1/actionlintRuns the official statically linked actionlint 1.7.12 release binary (MIT, SHA-256 checked against the published checksums) in an isolated child process without network, with the bundled ShellCheck 0.11.0 for run: scripts (pyflakes is not a
- Codewerk0.004 USDC
api changelog
POSThttps://code.halowerk.com/v1/api-changelogCompares operations, parameters, request bodies, response codes and media types, component schemas (one property level), servers and security schemes of two documents (Swagger 2.0 is converted with swagger2openapi first; 3.0 and 3.1 are rea