Skip to content

docs(base): clarify field description usage in json#90

Merged
zgz2048 merged 3 commits intolarksuite:mainfrom
zgz2048:codex/base-field-description-sync
Mar 31, 2026
Merged

docs(base): clarify field description usage in json#90
zgz2048 merged 3 commits intolarksuite:mainfrom
zgz2048:codex/base-field-description-sync

Conversation

@zgz2048
Copy link
Copy Markdown
Collaborator

@zgz2048 zgz2048 commented Mar 30, 2026 •
edited
Loading

Summary

  • clarify in base field shortcut help text that description should be passed via --json.description
  • update base field skill/reference docs to keep the existing --json model
  • drop the extra field-specific flag and test/code-path changes from the earlier revision

Why

The existing field shortcuts already pass arbitrary JSON bodies through. This update only needs to make the description usage explicit while keeping the original command shape.

Validation

  • go test ./shortcuts/base -run 'Test(DryRunFieldOps|BaseFieldExecuteUpdate|BaseFieldExecuteCRUD|BuildFieldBody)$'

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 30, 2026 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@zgz2048 zgz2048 changed the title [codex] support base field description input feat(base): support base field description input Mar 30, 2026
@zgz2048 zgz2048 added the domain/base PR touches the base domain label Mar 30, 2026
@zgz2048 zgz2048 self-assigned this Mar 30, 2026
@zgz2048 zgz2048 changed the title feat(base): support base field description input docs(base): clarify field description usage in json Mar 30, 2026
@zgz2048 zgz2048 force-pushed the codex/base-field-description-sync branch from 1448194 to 65cbdbd Compare March 30, 2026 09:17
@zgz2048 zgz2048 marked this pull request as ready for review March 30, 2026 12:09
@kongenpei kongenpei self-requested a review March 31, 2026 07:10
kongenpei
kongenpei approved these changes Mar 31, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@kongenpei kongenpei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zgz2048 zgz2048 merged commit c8341bb into larksuite:main Mar 31, 2026
1 check passed
tuxedomm pushed a commit that referenced this pull request Apr 3, 2026
@zgz2048
docs(base): clarify field description usage in json (#90)
42c7d21 
* docs(base): clarify field description usage in json

* chore(base docs): clarify field description usage

* docs(base): add description to field schema
@zgz2048 zgz2048 linked an issue Apr 16, 2026 that may be closed by this pull request
希望支持多维表格设置 字段默认值（default_value）和字段描述（description） #200
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kongenpei kongenpei kongenpei approved these changes

Assignees

@zgz2048 zgz2048

Labels

domain/base PR touches the base domain

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

希望支持多维表格设置 字段默认值（default_value）和字段描述（description）

3 participants

@zgz2048 @CLAassistant @kongenpei