Skip to content
HALOWERK

File Formats and Conversion

merge patch removed members

JSON Merge Patch returns the pointers of existing members explicitly removed by null instructions. Use it when an agent needs a deletion manifest.

POST https://format.halowerk.com/v1/merge-patch-removed-members

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": {
        "removed": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "removed"
      ]
    },
    "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 โ†’