Codewerk
api changelog
Compares 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 read directly) and sorts every difference into the Keep a Changelog 1.1.0 sections (keepachangelog.com): Added, Changed, Deprecated, Removed, Security; documentation-only edits are listed as Changed. Entries that can break clients are marked. The suggested.
POST https://code.halowerk.com/v1/api-changelogInputs
| Field | Type | Required | Description |
|---|---|---|---|
| base | See schema | Yes | The previous 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. |
| release | string | No | Version label for the heading (default: info.version of the revision). |
| date | string | No | Release date YYYY-MM-DD for the heading (omitted if not given). |
Show full input schema
{
"type": "object",
"additionalProperties": false,
"required": [
"base",
"revision"
],
"properties": {
"base": {
"description": "The previous 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
}
]
},
"release": {
"type": "string",
"maxLength": 50,
"description": "Version label for the heading (default: info.version of the revision)."
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Release date YYYY-MM-DD for the heading (omitted if not given)."
}
}
}Published input example
{
"base": {
"openapi": "3.0.3",
"info": {
"title": "Pets",
"version": "1.0.0"
},
"paths": {
"/pets": {
"get": {
"summary": "List pets",
"responses": {
"200": {
"description": "ok"
}
}
}
}
}
},
"revision": {
"openapi": "3.0.3",
"info": {
"title": "Pets",
"version": "1.1.0"
},
"paths": {
"/pets": {
"get": {
"summary": "List pets",
"responses": {
"200": {
"description": "ok"
}
}
},
"post": {
"summary": "Add a pet",
"responses": {
"201": {
"description": "created"
}
}
}
}
}
},
"date": "2026-11-01"
}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
asyncapi validate
POSThttps://code.halowerk.com/v1/asyncapi-validateRuns the Spectral asyncapi ruleset (@stoplight/spectral-rulesets 1.23.0), whose schema rules validate the document against the official AsyncAPI JSON Schemas shipped in @asyncapi/specs 6.11.1 (AsyncAPI 2.0.0-2.6.0 and 3.0.0/3.1.0), checks t