docs(base): align record write schema guidance#2000
Conversation
📝 WalkthroughWalkthroughThe Base batch-create payload format is updated from ChangesRecord batch create contract
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@04c355d187d5d690db0fd6427f18894378fcea8e🧩 Skill updatenpx skills add zgz2048/cli#codex/base-record-object-schema -y -g |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@shortcuts/base/base_execute_test.go`:
- Around line 2442-2445: Update the batch-create test around
BaseRecordBatchCreate to capture the mock request, decode its CapturedBody, and
assert that the request contains both expected create_records maps while
excluding legacy fields and rows keys. Keep the existing response assertions,
and ensure the request-body assertions fail if the implementation reverts to the
legacy payload shape.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 351f3138-42d5-40ec-9eb8-629f646efc63
📒 Files selected for processing (11)
shortcuts/base/base_execute_test.goshortcuts/base/base_shortcuts_test.goshortcuts/base/field_search_options.goshortcuts/base/record_batch_create.goshortcuts/base/record_ops.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-cell-value.mdskills/lark-base/references/lark-base-record-batch-create.mdskills/lark-base/references/lark-base-record-upsert.mdtests/cli_e2e/base/base_record_batch_update_workflow_test.gotests/cli_e2e/base/coverage.md
Summary
Align Base record-write guidance with the object-based batch schemas exposed by the current OpenAPI. Batch create now consistently teaches
create_records, while batch update continues to teachupdate_records; legacy request shapes are removed from agent-facing guidance.Changes
+record-batch-createhelp, tips, skill references, and workflow coverage to use one field map percreate_recordsentry.+field-listor+field-search-optionsbefore writing.Test Plan
make unit-testgo vet ./...make fmt-checknode scripts/skill-format-check/index.js skillscreate_records/update_recordsguidance.Related Issues
Summary by CodeRabbit
Documentation
create_recordsJSON format.Tests