trailofbits / trailofbits/graphtage

Feature Request: JSONPatch output

Open
#27 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2.5k
Forks
61
Avg merge
6h 45m
Merged PRs (30d)
45

Description

JSONPatch is a format for submitting machine usable but still marginally human readable partial record updates, usually over the HTTP PATCH method. While I've always been interested in using it to accept updates via an api, the usual problem is while there are any number of libraries that can take the patch and apply it to an existing record, the opposite, taking two records and generating the patch, doesn't seem to exist (at least as of my last search). Graphtage looks like it might be well suited to doing so and would be a nice selling point for it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing Graphtage's existing semantic diff entry points and the JSONPatch specification. Define how two records should produce a valid JSONPatch document, then add coverage showing that the generated patch can represent their differences.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.