Skip to content

docs(base): document UI-only field settings#1078

Merged
zgz2048 merged 1 commit into
larksuite:mainfrom
zgz2048:codex/issue-1061-ui-only-config
May 26, 2026
Merged

docs(base): document UI-only field settings#1078
zgz2048 merged 1 commit into
larksuite:mainfrom
zgz2048:codex/issue-1061-ui-only-config

Conversation

@zgz2048
Copy link
Copy Markdown
Collaborator

@zgz2048 zgz2048 commented May 25, 2026

Summary

Document Base field settings that are UI-only or intentionally protected so AI agents do not infer missing support from field metadata.

Changes

  • Mark select reference option conditions / cascading filters as Base frontend-only settings that OpenAPI and CLI cannot read, create, or update.
  • Mark link field filters as Base frontend-only settings with the same OpenAPI/CLI limitation.
  • Document Object, Button, and Stage fields as unsupported not_support fields that are protected from modification and content reads.

Test Plan

  • Unit tests pass: go test ./shortcuts/base
  • Manual local verification confirms the docs diff is scoped to skills/lark-base/references/lark-base-shortcut-field-properties.md

Related Issues

Summary by CodeRabbit

Documentation

  • Clarified that select dynamic cascading options and link field filtering are UI-only features not supported via CLI.
  • Added information about Object, Button, and Stage fields that are not supported via CLI.
  • Enhanced field properties documentation with notes on unsupported features and CLI limitations.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 000bfab1-88ac-4cb6-a61f-df1dbff58883

📥 Commits

Reviewing files that changed from the base of the PR and between ac06eaa and 86dbb9b.

📒 Files selected for processing (1)
  • skills/lark-base/references/lark-base-shortcut-field-properties.md

📝 Walkthrough

Walkthrough

This PR updates documentation for Lark base field properties by adding clarifications about CLI limitations. It notes that dynamic cascading option conditions and link field filtering are UI-only features unavailable via CLI/OpenAPI, and introduces a new section defining Object, Button, and Stage fields as unsupported by CLI with read/write protection.

CLI Limitations and Unsupported Fields Documentation

Layer / File(s) Summary
CLI limitation clarifications and unsupported field definitions
skills/lark-base/references/lark-base-shortcut-field-properties.md
Adds notes that dynamic cascading conditions and link filtering are UI-only (not in OpenAPI), clarifying the CLI cannot read/create/update them. Introduces a new "暂不支持字段" section documenting Object/Button/Stage fields as CLI-unsupported with not_support protection, renumbering subsequent sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • kongenpei

Poem

📚 A rabbit adds notes to the guidebook today,
Marking what CLI simply can't convey,
Cascading and filtering live UI-bound,
While Object and Button make no CLI sound—
Clear warnings so developers won't astray! 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main documentation change: adding documentation for UI-only field settings in the Base service.
Description check ✅ Passed The pull request description fully aligns with the required template, including a clear summary, detailed changes list, comprehensive test plan with checkmarks, and proper issue references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels May 25, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.83%. Comparing base (ac06eaa) to head (86dbb9b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1078   +/-   ##
=======================================
  Coverage   67.83%   67.83%           
=======================================
  Files         592      592           
  Lines       55327    55327           
=======================================
  Hits        37532    37532           
  Misses      14683    14683           
  Partials     3112     3112           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@86dbb9b7e50ac4f938efcb28cc13154431442ba8

🧩 Skill update

npx skills add zgz2048/cli#codex/issue-1061-ui-only-config -y -g

@zgz2048 zgz2048 merged commit 877fbe6 into larksuite:main May 26, 2026
21 checks passed
@liangshuo-1 liangshuo-1 mentioned this pull request May 26, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants