Skip to content
HALOWERK

Codewerk

protobuf breaking

Parses both versions with protobufjs 8.8.1 (proto2/proto3, bundled well-known types) and applies buf's breaking-change rules with their category membership as documented at buf.build/docs/breaking/rules (retrieved 2026-11-01): message/enum/service/field/enum-value/RPC deletion (with the *_UNLESS_NUMBER_RESERVED / *_UNLESS_NAME_RESERVED variants for WIRE and WIRE_JSON), field type with wire- and JSON-compatible groups (int32/uint32/int64/uint64/bool, sint32/sint64, fixed32/sfixed32,.

POST https://code.halowerk.com/v1/protobuf-breaking

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
old_protostringYesPrevious .proto source.
new_protostringYesNew .proto source.
categorystringNobuf category to enforce: FILE (default, strictest), PACKAGE, WIRE_JSON or WIRE.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "old_proto",
    "new_proto"
  ],
  "properties": {
    "old_proto": {
      "type": "string",
      "minLength": 5,
      "maxLength": 500000,
      "description": "Previous .proto source."
    },
    "new_proto": {
      "type": "string",
      "minLength": 5,
      "maxLength": 500000,
      "description": "New .proto source."
    },
    "category": {
      "type": "string",
      "enum": [
        "FILE",
        "PACKAGE",
        "WIRE_JSON",
        "WIRE"
      ],
      "default": "FILE",
      "description": "buf category to enforce: FILE (default, strictest), PACKAGE, WIRE_JSON or WIRE."
    }
  }
}

Open original schema

Published input example

{
  "category": "WIRE_JSON",
  "old_proto": "syntax = \"proto3\";\npackage shop.v1;\nmessage Order { string id = 1; string email = 2; }",
  "new_proto": "syntax = \"proto3\";\npackage shop.v1;\nmessage Order { string id = 1; reserved 2; reserved \"email\"; }"
}

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 โ†’