Skip to content

docs(task): document custom_fields and custom_field_options API#524

Merged
zero-my merged 1 commit intolarksuite:mainfrom
zero-my:feat/task-custom-fields
Apr 16, 2026
Merged

docs(task): document custom_fields and custom_field_options API#524
zero-my merged 1 commit intolarksuite:mainfrom
zero-my:feat/task-custom-fields

Conversation

@zero-my
Copy link
Copy Markdown
Collaborator

@zero-my zero-my commented Apr 16, 2026

Summary

This PR supplements the SKILL.md for Lark Tasks with the native API references and permission mappings for custom_fields and custom_field_options. This allows AI Agents to discover and correctly call the raw endpoints for task custom field operations, since these endpoints are not currently exposed in Level 2 OpenAPI commands or Level 1 Shortcuts.

Changes

  • Added custom_fields endpoints (create, get, patch, list, add, remove) to the API Resources list.
  • Added custom_field_options endpoints (create, patch) to the API Resources list.
  • Mapped all corresponding task:custom_field:read and task:custom_field:write scopes to the permission table.

Test Plan

  • Unit tests pass (go test ./shortcuts/task and make unit-test verified)
  • Manual local verification confirms the documentation renders correctly and markdown formatting is intact.

Related Issues

  • None

@github-actions github-actions Bot added domain/task PR touches the task domain size/M Single-domain feat or fix with limited business impact labels Apr 16, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

Documentation update for the Lark task skill that extends the API resource reference. Two new API resource sections for custom_fields and custom_field_options were added, listing their supported methods and descriptions. The permissions table was updated with corresponding task scope requirements.

Changes

Cohort / File(s) Summary
API Documentation
skills/lark-task/SKILL.md
Added custom_fields API resource section with create, get, patch, and list methods; added custom_field_options resource with create and patch methods. Updated permissions table with task:custom_field:* and task:custom_field_options:* scopes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested labels

domain/task, size/M

Suggested reviewers

  • LuckyTerry
  • tengchengwei

Poem

🐰 Custom fields now shine so bright,
Options spring up left and right,
Docs expanded, scopes aligned,
API references refined! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: documenting two new API resource sections in the Lark Tasks skill.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description comprehensively covers all required template sections with clear, specific details about motivation, changes, and verification.

✏️ 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.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@c1d6042). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #524   +/-   ##
=======================================
  Coverage        ?   59.05%           
=======================================
  Files           ?      384           
  Lines           ?    32636           
  Branches        ?        0           
=======================================
  Hits            ?    19274           
  Misses          ?    11553           
  Partials        ?     1809           

☔ 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@421546725bb506219ee22620c19da103bbeceea3

🧩 Skill update

npx skills add zero-my/cli#feat/task-custom-fields -y -g

@zero-my zero-my merged commit 6ad25cd into larksuite:main Apr 16, 2026
28 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/task PR touches the task 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