Skip to content
HALOWERK

File Formats and Conversion

merge patch structural transitions

JSON Merge Patch identifies existing members whose JSON types change. Use it when an agent needs a schema migration review.

POST https://format.halowerk.com/v1/merge-patch-structural-transitions

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
baseobjectYes
patchobjectYes
Show full input schema
{
  "type": "object",
  "properties": {
    "base": {
      "type": "object",
      "additionalProperties": true
    },
    "patch": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "required": [
    "base",
    "patch"
  ],
  "additionalProperties": false
}

Open original schema

Published input example

{
  "base": {
    "report": "monthly",
    "months": [
      1,
      2,
      3
    ]
  },
  "patch": {
    "report": {
      "period": "annual"
    },
    "months": [
      1,
      2,
      3
    ],
    "note": null
  }
}

Result & documentation

Show published result schema
{
  "type": "object",
  "required": [
    "measured_at",
    "source",
    "data",
    "limitations"
  ],
  "properties": {
    "measured_at": {
      "type": "string"
    },
    "source": {
      "type": "object",
      "required": [
        "reference",
        "retrieved_at"
      ],
      "properties": {
        "reference": {
          "type": "string"
        },
        "retrieved_at": {
          "type": "string"
        }
      }
    },
    "data": {
      "type": "object",
      "properties": {
        "transitions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "from": {
                "type": "string"
              },
              "to": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "from",
              "to"
            ]
          }
        }
      },
      "required": [
        "transitions"
      ]
    },
    "limitations": {
      "type": "string"
    }
  }
}

Machine-readable documentation of this hub

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

More endpoints in this hub

All endpoints in this hub โ†’