You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/1.2.0-dev.md
+26-2Lines changed: 26 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,8 @@ This is the root object of the [Overlay](#overlay).
84
84
| <aname="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. |
85
85
| <aname="overlay-info"></a>info |[Info Object](#info-object)|**REQUIRED**. Provides metadata about the Overlay. The metadata MAY be used by tooling as required. |
86
86
| <aname="overlay-extends"></a>extends |`string`| URI reference that identifies the target document (such as an [[OpenAPI]] document) this overlay applies to. |
87
-
| <aname="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
+
| <aname="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
+
| <aname="overlay-components"></a>components |[Component Object](#component-object)| A set of components to reuse across the Overlay Document. Optional. |
88
89
89
90
This object MAY be extended with [Specification Extensions](#specification-extensions).
90
91
@@ -128,6 +129,18 @@ The metadata MAY be used by the clients if needed.
128
129
129
130
This object MAY be extended with [Specification Extensions](#specification-extensions).
130
131
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
+
131
144
#### Action Object
132
145
133
146
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
176
189
177
190
| Field Name | Type | Description |
178
191
| ---- | :----: | ---- |
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. |
180
193
| <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
194
182
195
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
+
183
207
This object MAY be extended with [Specification Extensions](#specification-extensions).
0 commit comments