Skip to content
HALOWERK

File Formats and Conversion

merge patch reverse document

JSON Merge Patch returns a reverse patch when the original document can be reconstructed, with unrepresentable null assignments listed. Use it when an agent needs an exact undo document.

POST https://format.halowerk.com/v1/merge-patch-reverse-document

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": {
    "article": {
      "title": "Transit",
      "lang": "de"
    },
    "tags": [
      "bahn",
      "bus"
    ],
    "edition": 2
  },
  "patch": {
    "article": {
      "lang": "en"
    },
    "tags": [
      "rail"
    ],
    "edition": null,
    "draft": 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": {
        "possible": {
          "type": "boolean"
        },
        "reverse": {
          "type": [
            "object",
            "null"
          ]
        },
        "blocked": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "possible",
        "reverse",
        "blocked"
      ]
    },
    "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 โ†’