Data.Aeson.Diff

This module implements data types and operations to represent the differences between JSON documents (i.e. a patch), to compare JSON documents and extract such a patch, and to apply such a patch to a JSON document.

Patches

data Patch

Describes the changes between two JSON documents.

Constructors

Patch

Fields

patchOperations :: [Operation]

Instances

Eq Patch

Show Patch

ToJSON Patch

FromJSON Patch

Monoid Patch

type Path = [Key]

A path through a JSON document is a possibly empty sequence of Keys.

data Key

Traverse a single layer of a JSON document.

Constructors

OKey Text

Traverse a Value with an Object constructor.

AKey Int

Traverse a Value with an Array constructor.

Instances

Eq Key

Ord Key

Show Key

ToJSON Key

FromJSON Key

data Operation

An Operation describes an atomic change to a JSON document: inserting or deleting a single Value at a specific point.

Constructors

Ins

Insert a Value at a location.

Fields

changePath :: Path

changeValue :: Value

Del

Delete the Value at a location.

Fields

changePath :: Path

changeValue :: Value

Instances

Eq Operation

Show Operation

ToJSON Operation

FromJSON Operation

Functions

diff :: Value -> Value -> Patch

Compare two JSON documents and generate a patch describing the differences.

patch :: Patch -> Value -> Value

Apply a patch to a JSON document.

applyOperation :: Operation -> Value -> Value

Apply an Operation to a Value.

formatPatch :: Patch -> Text

Format a Patch for reading by humans.

For storing or exchanging Patches between systems using the JSON encoding implemented by the FromJSON and ToJSON instances.