docs(lark-base): document signature field (single-value attachment variant)#1531
Open
Neseria wants to merge 1 commit into
Open
docs(lark-base): document signature field (single-value attachment variant)#1531Neseria wants to merge 1 commit into
Neseria wants to merge 1 commit into
Conversation
|
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
✅ Files skipped from review due to trivial changes (5)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughVersion bumped to 1.3.0. Documentation for the ChangesSignature Field Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Tools execution failed with the following error: Failed to run tools: Ping-pong health check failed 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 |
github-actions
Bot
added
domain/base
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
skills/lark-base/references/lark-base-cell-value.md (1)
128-139: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueMinor grammar refinements suggested for clarity.
The static analysis tool flagged two Chinese grammar points (lines 130 and 138) that could be polished for consistency with documentation style, but the functional constraints are accurate and complete:
- Line 130: "写入新的签名图" could be more idiomatic than current phrasing
- Line 138: "不要把签字当普通附件追加" structure is understandable but could follow more standard phrasing
These are editorial and do not affect correctness. If the team prefers to standardize phrasing, minor edits could improve fluency.
🤖 Prompt for 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. In `@skills/lark-base/references/lark-base-cell-value.md` around lines 128 - 139, Review and refine the Chinese phrasing in the signature field documentation for better idiomatic consistency. The phrase "写入新的签名图" should be made more idiomatic and natural sounding, and the phrase "不要把签字当普通附件追加" should be adjusted to follow more standard documentation phrasing patterns. Ensure both revisions maintain the original functional meaning and constraints being documented while improving overall fluency and consistency with the documentation style guide.
🤖 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.
Nitpick comments:
In `@skills/lark-base/references/lark-base-cell-value.md`:
- Around line 128-139: Review and refine the Chinese phrasing in the signature
field documentation for better idiomatic consistency. The phrase "写入新的签名图"
should be made more idiomatic and natural sounding, and the phrase
"不要把签字当普通附件追加" should be adjusted to follow more standard documentation phrasing
patterns. Ensure both revisions maintain the original functional meaning and
constraints being documented while improving overall fluency and consistency
with the documentation style guide.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: db5efa45-ae1a-476c-b8a4-66aea00d6570
📒 Files selected for processing (8)
skills/lark-base/SKILL.mdskills/lark-base/references/lark-base-cell-value.mdskills/lark-base/references/lark-base-data-query.mdskills/lark-base/references/lark-base-field-create.mdskills/lark-base/references/lark-base-field-json.mdskills/lark-base/references/lark-base-field-update.mdskills/lark-base/references/lark-base-workflow-schema.mdskills/lark-base/references/lookup-field-guide.md
Neseria
force-pushed
the
feat/lark-base-signature-field
branch
from
3cf4ea3 to
6c3d6fc
Compare
A signature field reuses the attachment field and is created via
`{"type":"attachment","style":{"type":"signature"}}` — an attachment style
variant, not a standalone top-level type. Plain attachments stay backward
compatible with the bare `{"type":"attachment"}` payload.
- field-json: document attachment `style.type` (plain | signature)
- SKILL / field-create / field-update: create DSL and conversion rules for the
attachment + style form
- cell-value: signature cells are read / filter / clear only — record writes
reject a non-empty value, and upload-attachment reports them under
ignored_fields
- data-query / workflow-schema / lookup-guide: signature filters empty /
non-empty only
Neseria
force-pushed
the
feat/lark-base-signature-field
branch
from
dac98cc to
376d1d9
Compare
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
3 participants
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.
What
Documents the new Signature field across the
lark-baseskill. Signature reuses the attachment field (FieldType=17) and is distinguished byFieldUIType=Signature; the skill surfaces it as a new friendly type{"type":"signature"}(no rawui_type, consistent with the existing "no ui_type" rule).Why
The Signature field is shipping (PRD + frontend / business-backend / edit-link tech designs). The skill needs to teach the agent (a) how to create the field, and (b) the hard differences from a plain attachment — most importantly that in this phase the OpenAPI/CLI path is read / filter / clear-only and cannot write a signature image.
Changes (8 files, +47/-3)
signaturetype — no property, no default value, single value; do not hand-writeui_type/type:"attachment"(rawui_typeis silently downgraded to a plain Attachment).nullor+record-remove-attachment.type:"signature";any -> signatureclears the column,signature -> attachmentkeeps the image.empty/non_emptyonly; single value.Notes / depends on
{"type":"signature"}needs the CLI DSL mapping + OpenAPI gateway whitelistingSignatureinUITypeTrans[ATTACH]+ FGccm.base.field.signature. This docs PR should land together with that support (today the CLI forwardstypeverbatim, sotype:signatureis not yet mapped).Summary by CodeRabbit
lark-base文档版本至 1.3.0，并完善“签字字段（signature）”定义：作为附件的style.type="signature"语义，仅支持读取、isEmpty/isNotEmpty筛选与清空，禁止命令侧写入签名图片。+field-create创建示例与+field-get校验（style.type为signature才表示环境支持）。+data-query/字段过滤、+field-update全量更新与附件/签字互转规则、工作流与恢复/错误场景说明，避免签字能力丢失。