Updated Overlay proposal #2300
Merged
Updated Overlay proposal #2300
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MikeRalphson
suggested changes
Jul 30, 2020
| @@ -63,10 +63,11 @@ This object represents one or more changes to be applied to the target document | |||
| Field Name | Type | Description | |||
| ---|:---:|--- | |||
| <a name="updateTarget"></a>target | `string` | A JMESPath expression referencing the target objects in the target document. | |||
| <a name="updateValue"></a>value | [Any](#valueObject) | An object with the properties and values to be updated in the target document. Property has no impact if `remove` property is `true`. | |||
| <a name="updateAdd"></a>add | [Any](#addObject) | An object to be added as a child of the object(s) referenced by the target. Property has no impact if `remove` property is `true`. | |||
There was a problem hiding this comment.
I can see how add works for arrays. For objects, what is the name/key of the child object being added, or is add not applicable to objects?
| @@ -63,10 +63,11 @@ This object represents one or more changes to be applied to the target document | |||
| Field Name | Type | Description | |||
| ---|:---:|--- | |||
| <a name="updateTarget"></a>target | `string` | A JMESPath expression referencing the target objects in the target document. | |||
| <a name="updateValue"></a>value | [Any](#valueObject) | An object with the properties and values to be updated in the target document. Property has no impact if `remove` property is `true`. | |||
| <a name="updateAdd"></a>add | [Any](#addObject) | An object to be added as a child of the object(s) referenced by the target. Property has no impact if `remove` property is `true`. | |||
| <a name="updateMerge"></a>merge | [Any](#mergeObject) | An object with the properties and values to be merged with the object(s) referenced by the target. Property has no impact if `remove` property is `true`. | |||
There was a problem hiding this comment.
I can see how merge works for objects, but we should either say how merge works for arrays (provide an example?) or expressly forbid it.
Co-authored-by: Mike Ralphson <[email protected]>
MikeRalphson
approved these changes
Apr 1, 2021
|
@darrelmiller what is the right ticket to comment on Overlays as shown on the TSC call today? |
charjr
pushed a commit
to charjr/OpenAPI-Specification
that referenced
this pull request
Apr 27, 2023
* Updated Overlay proposal * fixed examples * Update proposals/004_Overlays.md Co-authored-by: Mike Ralphson <[email protected]> Co-authored-by: Mike Ralphson <[email protected]>
charjr
pushed a commit
to charjr/OpenAPI-Specification
that referenced
this pull request
Apr 27, 2023
* Updated Overlay proposal * fixed examples * Update proposals/004_Overlays.md Co-authored-by: Mike Ralphson <[email protected]> Co-authored-by: Mike Ralphson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated with "add" and "merge" fields instead of just "value".