JSONPath / provenance / handoff guide

Hand off JSONPath results with path, null, and missing state

A path identifies a source location, null is a present value, and missing is absence. Keep multiple matches separate and mark unavailable provenance as unknown.

Keep path and array position

A path such as $.users[2].name includes the original array index. Do not share only the extracted value; the same value can appear at another path. Record line or column only when the source tool supplied it.

path: $.users[2].name
value: "Aki"
array_index: 2
provenance: path only; source line unknown
BoundaryWhat to check
path/indexKeep the root path and array index; extraction order is not source position.
nullIf the key exists with null, record present-null.
missingIf the key does not exist, record missing instead of null.
multiple resultsKeep each match as its own path/value result.

Never fabricate provenance

JSONPath output alone cannot reveal a source file line or column. Mark positions the source did not provide as unknown; do not fill them by guesswork.

The existing JSONPath tool runs locally. This guide fixes handoff report fields and never sends input JSON externally.

Open the existing JSONPath tool

Review cases

caseoutcomecheck
array-indexpath-with-indexInclude the array index in the path.
explicit-nullpresent-nullSeparate null from a missing key.
missing-propertymissingDo not turn absent keys into null.
multiple-resultsseparate-resultsKeep each path and value separately.
source-provenance-absentprovenance-unknownDo not guess line or column.
unsupported-uploadrejectReturn uploads or unclear positions.

Do not send input

Do not paste production JSON, tokens, or personal data. Use harmless fixtures and share provenance only when supplied by the source tool.