Skip to content

Commit

Permalink
Reformatted after merging with main
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl committed Sep 10, 2024
1 parent 5497744 commit cc25436
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions versions/1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@ This object represents one or more changes to be applied to the target document

##### Fixed Fields

Field Name | Type | Description
---|:---:|---
<a name="action-target"></a>target | `string` | **REQUIRED** A JSONPath expression selecting nodes in the target document.
<a name="action-description"></a>description | `string` | A description of the action. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
<a name="action-update"></a>update | Any | If the `target` selects an object node, the value of this field should be an object with the properties and values to merge with the node. If the `target` selects an array, the value of this field should be an entry to append to the array. This field has no impact if the `remove` field of this action object is `true`.
<a name="action-remove"></a>remove | `boolean` | A boolean value that indicates that the target object is to be removed from the the map or array it is contained in. The default value is `false`.

The result of the `target` JSONPath expression must be zero or more objects or arrays (not primitive types or `null` values). If you wish to update or remove a primitive value such as a string, the `target` expression should select the *containing* object in the target document.
| Field Name | Type | Description |
| ---- | :----: | ---- |
| <a name="action-target"></a>target | `string` | **REQUIRED** A JSONPath expression selecting nodes in the target document. |
| <a name="action-description"></a>description | `string` | A description of the action. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
| <a name="action-update"></a>update | Any | If the `target` selects an object node, the value of this field should be an object with the properties and values to merge with the node. If the `target` selects an array, the value of this field should be an entry to append to the array. This field has no impact if the `remove` field of this action object is `true`. |
| <a name="action-remove"></a>remove | `boolean` | A boolean value that indicates that the target object is to be removed from the the map or array it is contained in. The default value is `false`. |

The result of the `target` JSONPath expression must be zero or more objects or arrays (not primitive types or `null` values). If you wish to update or remove a primitive value such as a string, the `target` expression should select the _containing_ object in the target document.

The properties of the update object MUST be compatible with the target object referenced by the JSONPath key. When the Overlay document is applied, the properties in the merge object replace properties in the target object with the same name and new properties are appended to the target object.

Expand Down

0 comments on commit cc25436

Please sign in to comment.