Skip to content

docs: add v2 api version to docs fetch examples#891

Merged
SunPeiYang996 merged 1 commit into
mainfrom
sun/chore2
May 14, 2026
Merged

docs: add v2 api version to docs fetch examples#891
SunPeiYang996 merged 1 commit into
mainfrom
sun/chore2

Conversation

@SunPeiYang996

@SunPeiYang996 SunPeiYang996 commented May 14, 2026

Copy link
Copy Markdown
Collaborator

Change-Id: I130e6e02c0b7594a05bdda6c9bf552fb15572791

Summary by CodeRabbit

  • Documentation
    • Updated documentation across Lark skills to clarify the use of --api-version v2 flag for document fetch, create, and update operations for consistency and correctness.
    • Refined guidance for whiteboard token retrieval, Markdown workflows, and block-level operations to reflect the proper API version requirements.

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Updated command guidance to consistently specify API version 2 requirements for document operations including fetch, create, and update across all skill modules
    • Clarified that document fetch operations support direct URL input
    • Synchronized whiteboard token retrieval, spreadsheet, and document handling workflows with explicit version requirements
    • Enhanced markdown export/update workflows with precise API version specifications

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 400bcfe8-26ff-4fe0-b878-4a9f4830c637

📥 Commits

Reviewing files that changed from the base of the PR and between 3985e37 and 4341a8b.

📒 Files selected for processing (11)
  • skill-template/domains/doc.md
  • skill-template/domains/drive.md
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-fetch.md
  • skills/lark-doc/references/lark-doc-md.md
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/references/lark-doc-whiteboard.md
  • skills/lark-doc/references/style/lark-doc-create-workflow.md
  • skills/lark-drive/SKILL.md
  • skills/lark-vc/SKILL.md
  • skills/lark-whiteboard/SKILL.md
✅ Files skipped from review due to trivial changes (9)
  • skills/lark-whiteboard/SKILL.md
  • skill-template/domains/doc.md
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-fetch.md
  • skills/lark-doc/references/style/lark-doc-create-workflow.md
  • skills/lark-drive/SKILL.md
  • skills/lark-vc/SKILL.md
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/references/lark-doc-md.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • skills/lark-doc/references/lark-doc-whiteboard.md
  • skill-template/domains/drive.md

📝 Walkthrough

Walkthrough

This PR updates documentation across skills and templates to consistently require --api-version v2 for docs +fetch, docs +create, and docs +update commands, and clarifies token/block-id fetching and URL support where applicable.

Changes

Docs API v2 flag standardization across documentation

Layer / File(s) Summary
lark-doc skill core guidance and prerequisites
skills/lark-doc/SKILL.md
lark-doc skill main docs updated to require --api-version v2 for docs +create, docs +fetch, and docs +update; prerequisites and synced-reference handling updated to reference v2.
lark-doc fetch and markdown operations
skills/lark-doc/references/lark-doc-fetch.md, skills/lark-doc/references/lark-doc-md.md
Reference docs updated to include --api-version v2 in fetch examples for embedded sheet/bitable guidance and markdown export/update workflows.
lark-doc update and whiteboard workflows
skills/lark-doc/references/lark-doc-update.md, skills/lark-doc/references/lark-doc-whiteboard.md, skills/lark-doc/references/style/lark-doc-create-workflow.md
Clarified that block-level edits and whiteboard token retrieval require docs +fetch --api-version v2 (use --detail with-ids for block IDs where noted).
Related skills and domain templates alignment
skill-template/domains/doc.md, skill-template/domains/drive.md, skills/lark-drive/SKILL.md, skills/lark-vc/SKILL.md, skills/lark-whiteboard/SKILL.md
Domain templates and skill docs aligned to use --api-version v2 for docs fetch examples; drive doc notes URL support and whiteboard/meeting token fetch examples require v2.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

domain/ccm, size/M

Suggested reviewers

  • liangshuo-1
  • fangshuyu-768
  • zhaoleibd

Poem

A rabbit reads each doc with care,
Adds v2 flags here and there,
Tokens fetched, examples cleare,
Hop—consistency is near! 🐇✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description lacks required sections from the template. Missing: explicit Changes list, Test Plan with checkboxes, and properly formatted Related Issues section. Add a bulleted Changes section listing main documentation updates, include the Test Plan checklist template, and format Related Issues section as specified in the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding v2 api version parameter to documentation examples for docs fetch commands.
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
  • Commit unit tests in branch sun/chore2

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/ccm PR touches the ccm domain domain/vc PR touches the vc domain size/L Large or sensitive change across domains or core paths labels May 14, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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 `@skill-template/domains/doc.md`:
- Line 118: The sentence currently promotes the legacy trigger `docs +search`;
change it to reference `drive +search` instead so the resource-discovery
recommendation matches the updated lark-doc skill deprecation guidance—locate
the phrase containing `docs +search` in doc.md (the sentence describing
resource-discovery入口 and "表格 / 报表") and replace `docs +search` with `drive
+search`, keeping the rest of the wording intact and ensuring the sentence still
reads naturally.

In `@skills/lark-doc/references/lark-doc-md.md`:
- Line 44: The example showing the command "docs +fetch --api-version v2"
assumes markdown output but the tool defaults to XML; update the example command
to include the "--doc-format markdown" flag so the fetch actually exports
Markdown (e.g., replace occurrences of "docs +fetch --api-version v2" with "docs
+fetch --api-version v2 --doc-format markdown" in the example) and mention the
flag where the workflow expects markdown output.
🪄 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: d702098e-d990-4958-b0f0-ec49fa90896e

📥 Commits

Reviewing files that changed from the base of the PR and between 8a8dff4 and 3985e37.

📒 Files selected for processing (11)
  • skill-template/domains/doc.md
  • skill-template/domains/drive.md
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-fetch.md
  • skills/lark-doc/references/lark-doc-md.md
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/references/lark-doc-whiteboard.md
  • skills/lark-doc/references/style/lark-doc-create-workflow.md
  • skills/lark-drive/SKILL.md
  • skills/lark-vc/SKILL.md
  • skills/lark-whiteboard/SKILL.md

Comment thread skill-template/domains/doc.md
Comment thread skills/lark-doc/references/lark-doc-md.md
@github-actions

github-actions Bot commented May 14, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@4341a8b17d8d176fb4277cde00fda152820ffd0d

🧩 Skill update

npx skills add larksuite/cli#sun/chore2 -y -g

Change-Id: I130e6e02c0b7594a05bdda6c9bf552fb15572791
@codecov

codecov Bot commented May 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.90%. Comparing base (52e0129) to head (4341a8b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #891   +/-   ##
=======================================
  Coverage   65.90%   65.90%           
=======================================
  Files         520      520           
  Lines       49274    49274           
=======================================
  Hits        32474    32474           
  Misses      14026    14026           
  Partials     2774     2774           

☔ 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/ccm PR touches the ccm domain domain/vc PR touches the vc domain size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants