Skip to content
HALOWERK

File Formats and Conversion

merge patch pointer presence

JSON Merge Patch checks which required JSON Pointers would be absent in the resulting document. Use it when an agent needs a handoff presence check.

POST https://format.halowerk.com/v1/merge-patch-pointer-presence

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
baseobjectYes
patchobjectYes
pointersarrayYes
Show full input schema
{
  "type": "object",
  "properties": {
    "base": {
      "type": "object",
      "additionalProperties": true
    },
    "patch": {
      "type": "object",
      "additionalProperties": true
    },
    "pointers": {
      "type": "array",
      "maxItems": 40,
      "minItems": 1,
      "items": {
        "type": "string",
        "maxLength": 180
      }
    }
  },
  "required": [
    "base",
    "patch",
    "pointers"
  ],
  "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
  },
  "pointers": [
    "/article/title",
    "/edition"
  ]
}

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