Skip to content
HALOWERK

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

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
baseSee schemaYesThe previous 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.
releasestringNoVersion label for the heading (default: info.version of the revision).
datestringNoRelease 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)."
    }
  }
}

Open original schema

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

All endpoints in this hub โ†’