Skip to content

Commit d2748b4

Browse files
committed
feat: adds the action template reference object
Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
1 parent 5cbd075 commit d2748b4

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

versions/1.2.0-dev.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ This is the root object of the [Overlay](#overlay).
8484
| <a name="overlay-version"></a>overlay | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the Overlay Specification that the Overlay document uses. The `overlay` field SHOULD be used by tooling to interpret the Overlay document. |
8585
| <a name="overlay-info"></a>info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the Overlay. The metadata MAY be used by tooling as required. |
8686
| <a name="overlay-extends"></a>extends | `string` | URI reference that identifies the target document (such as an [[OpenAPI]] document) this overlay applies to. |
87-
| <a name="overlay-actions"></a>actions | [[Action Object](#action-object)] | **REQUIRED** An ordered list of actions to be applied to the target document. The array MUST contain at least one value. |
87+
| <a name="overlay-actions"></a>actions | [[Action Object](#action-object) or [Action Template Reference Object](#action-template-reference-object)] | **REQUIRED** An ordered list of actions to be applied to the target document. The array MUST contain at least one value. |
88+
| <a name="overlay-components"></a>components | [Component Object](#component-object) | A set of components to reuse across the Overlay Document. Optional. |
8889

8990
This object MAY be extended with [Specification Extensions](#specification-extensions).
9091

@@ -128,6 +129,18 @@ The metadata MAY be used by the clients if needed.
128129

129130
This object MAY be extended with [Specification Extensions](#specification-extensions).
130131

132+
#### Component Object
133+
134+
The object provides a set of components to be reused across the Overlay document.
135+
136+
##### Fixed Fields
137+
138+
| Field Name | Type | Description |
139+
| ---- | :----: | ---- |
140+
| <a name="component-action-templates"></a>actionTemplates | Map(`string`, [Action Template Object](#action-template-object)) | A key-value set of action templates to reference in the actions. Optional. |
141+
142+
This object MAY be extended with [Specification Extensions](#specification-extensions).
143+
131144
#### Action Object
132145

133146
This object represents one or more changes to be applied to the target document at the locations defined by the target JSONPath expression.
@@ -176,10 +189,21 @@ This object MAY be extended with [Specification Extensions](#specification-exten
176189

177190
| Field Name | Type | Description |
178191
| ---- | :----: | ---- |
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. |
192+
| <a name="action-template-parameter-name"></a>name | `string` | **REQUIRED** The name of the parameter, MUST match the key for the string literal replacement expression. |
180193
| <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. |
181194

182195

196+
This object MAY be extended with [Specification Extensions](#specification-extensions).
197+
198+
#### Action template reference object
199+
200+
##### Fixed fields
201+
202+
| Field Name | Type | Description |
203+
| ---- | :----: | ---- |
204+
| <a name="action-template-reference-ref"></a>$ref | `string` | **REQUIRED** A valid reference to an action template in the components section, represented as `#/components/actionTemplates/actionTemplateKey`. |
205+
| <a name="action-template-parameter-values>parameterValues | `Map(string, Any)` | A set of values to use for the template parameters, the key MUST match the parameter name. Optional. |
206+
183207
This object MAY be extended with [Specification Extensions](#specification-extensions).
184208

185209
### String literal replacement syntax

0 commit comments

Comments
 (0)