Skip to content

Commit 74f3a40

Browse files
committed
feat: adds high level definitions for templates and templates parameters
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
1 parent 38198c9 commit 74f3a40

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

versions/1.2.0-dev.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,31 @@ The properties of the `update` or `copy` object MUST be compatible with the targ
155155
- An object value of the `update` or `copy` property is recursively merged with an object value of the target property.
156156
- Other property value combinations are incompatible and result in an error.
157157

158+
This object MAY be extended with [Specification Extensions](#specification-extensions).
159+
160+
#### Action template object
161+
162+
This object represents one or more changes to be applied to the target document at the locations defined by the target JSONPath expression and reused in one of more action references.
163+
164+
##### Fixed fields
165+
166+
| Field Name | Type | Description |
167+
| ---- | :----: | ---- |
168+
| <a name="action-template-parameters"></a>parameters | [[Action template parameter object](#action-template-parameter-object)] | A list of parameters to be used during string literal replacement. Optional. |
169+
| Any field defined in the [action object](#action-object) | mixed | The [string literal replacement syntax](#string-literal-replacement-syntax) MAY be used for any of the fields, and the replacements MUST be evaluated as the template reference is being resolved. |
170+
171+
This object MAY be extended with [Specification Extensions](#specification-extensions).
172+
173+
#### Action template parameter object
174+
175+
##### Fixed fields
176+
177+
| Field Name | Type | Description |
178+
| ---- | :----: | ---- |
179+
| <a name="action-template-parameter-name"></a>name | `string` | The name of the parameter, MUST match the key for the string literal replacement expression. Required. |
180+
| <a name="action-template-parameter-default>default | Any | A default value for the parameter to use when no value is provided by the reference. Optional. |
181+
182+
158183
This object MAY be extended with [Specification Extensions](#specification-extensions).
159184

160185
### String literal replacement syntax

0 commit comments

Comments
 (0)