Refactor Examples, Appendix sections #1
Conversation
- Add Examples summary table - Reorganize Examples section for readability and structure. - Move File Naming Conventions section to appendix and resequenced. - Add Array Move and Array Replace examples. - Standardized headings. - Add #action-object target on Action Object heading. - Remove unused #overlay-actions hyperlink. - No other content above ## Examples was changed.
|
Also, please review my array move and array replace examples, just to have a 2nd set of eyes on them. |
There was a problem hiding this comment.
Thank you for the contribution! Overall, I think this is a great improvement over what we have.
My main concern is that a large number of the changes are actually unrelated to the copy proposal. I think it'd make more sense to suggest them separately so we can review them independently and both have a chance to get merged faster.
| ### Overlay | ||
|
|
||
| An Overlay is a JSON or YAML structure containing an ordered list of [Action Objects](#overlay-actions) that are to be applied to the target document. Each [Action Object](#action-object) has a `target` property and a modifier type (`update` or `remove`). The `target` property is a [[RFC9535|JSONPath]] query expression that identifies the elements of the target document to be updated and the modifier determines the change. | ||
| An Overlay is a JSON or YAML structure containing an ordered list of [Action Objects](#action-object) that are to be applied to the target document. Each Action Object has a `target` property and a modifier type (`update` or `remove`). The `target` property is a [[RFC9535|JSONPath]] query expression that identifies the elements of the target document to be updated and the modifier determines the change. |
There was a problem hiding this comment.
| An Overlay is a JSON or YAML structure containing an ordered list of [Action Objects](#action-object) that are to be applied to the target document. Each Action Object has a `target` property and a modifier type (`update` or `remove`). The `target` property is a [[RFC9535|JSONPath]] query expression that identifies the elements of the target document to be updated and the modifier determines the change. | |
| An Overlay is a JSON or YAML structure containing an ordered list of [Action Objects](#action-object) that are to be applied to the target document. Each Action Object has a `target` property and a modifier type (`update`, `remove`, or `copy`). The `target` property is a [[RFC9535|JSONPath]] query expression that identifies the elements of the target document to be updated and the modifier determines the change. |
There was a problem hiding this comment.
@baywet — I don't know how #overlay-actions slipped through the cracks, I know I fixed that, but somehow it got reverted.
Since this is the only change you are looking for, can you just decline this PR and then apply this one change yourself rather than have me cut the much larger PR down? Then I will target the PR to the OAI repo instead.
Alternately I can submit a new PR with this one change. Let me know.
There was a problem hiding this comment.
by this one change, do you mean the addition of "or copy"?
There was a problem hiding this comment.
@baywet — My PR was just suggestions, so whatever aspects you feel apply to and improve your PR.
@mikeschinkel Signed-off-by: Vincent Biret <vincentbiret@hotmail.com>
|
Thanks. I've ported the changes immediately relevant to the copy proposal in OAI@b987b53 I'll now rebase my branch onto the latest main changes, so the link might be broken really soon. But rest assured that contributions are in! Thanks! Closing. |
|
@baywet — Good deal. Glad I was able to contribute something useful. |
2 participants
Summary
Add table with links for Examples section and related revisions — no normative changes.
Updates
Examplesto##level and marked as non-normativeUpdate,Copy,Move,Array)Note for review
The
x-oai-traitsexample currently defines an array (['paged']), while the selector$.paths.*.get[?@.x-oai-traits.paged]assumes an object.Please verify whether
{ paged: true }or an array-membership test was intended.Only content above
## Examplesthat has been changed is adding a link target and fixing broken links.