feat: update documentation on field omission for updates and upserts#28
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR strengthens the Make skills documentation by explicitly warning that update/upsert/patch modules must omit mapper fields that should remain unchanged, because mapping an empty string can silently overwrite existing record data.
Changes:
- Added a new “Field Omission on Updates and Upserts” section with rationale and examples in
make-module-configuring/mapping.md. - Introduced a new cardinal rule in
make-module-configuring/SKILL.mdand reinforced the guidance ingeneral-principles.md. - Added a cross-skill “gotcha” note in
make-scenario-building/mapping.mdpointing readers to the new section.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| skills/make-scenario-building/mapping.md | Adds a gotcha warning about empty-string mappings on update/upsert/patch modules and links to the configuring skill for details. |
| skills/make-module-configuring/SKILL.md | Adds a new cardinal rule requiring omission of unwritten mapper fields on updates/upserts/patches. |
| skills/make-module-configuring/mapping.md | Adds a dedicated section explaining why mapper field omission matters, with wrong/right examples and guidance for clearing fields. |
| skills/make-module-configuring/general-principles.md | Extends the “empty vs null vs missing” gotcha to explicitly call out update/upsert mapper overwrite risk and links to the new section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- mapping.md:115 (r3304900933): reword "function" → "keyword" for IML `erase`; matches the Keywords table in iml-expressions.md (alongside `null` and `ignore`) and avoids implying invocation as `erase(...)`. - scenario-building/mapping.md:85 (r3304901017): clarify that the empty string is the *value*, not the key — "including a key with `""`" was ambiguous; reworded to "including a field with an empty-string value (`""`)". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
lenkalankova
approved these changes
May 27, 2026
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
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.
This PR strengthens the Make skills documentation by explicitly warning that update/upsert/patch modules must omit mapper fields that should remain unchanged, because mapping an empty string can silently overwrite existing record data.