docs(skills): migrate docs +search to drive +search and fix creator_ids owner semantic#951
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR updates CLI help and multiple skill docs to make ChangesDrive search semantics and routing consolidation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
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)
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 |
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@9ed4a1dc417a3c122a308ae696ed55550b35e218🧩 Skill updatenpx skills add larksuite/cli#feat/doc-search -y -g |
e84a88a to
51e1450
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #951 +/- ##
=======================================
Coverage 67.58% 67.58%
=======================================
Files 575 575
Lines 54269 54269
=======================================
Hits 36679 36679
Misses 14548 14548
Partials 3042 3042 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1ef5472 to
168850c
Compare
…ds owner semantic
docs +search is in maintenance and will be removed; cloud-space resource
discovery is consolidated onto drive +search. Two related doc/help fixes:
1. Redirect guidance: docs +search -> drive +search
- skill-template/domains/{doc,sheets}.md
- lark-base/SKILL.md: --filter '{"doc_types":["BITABLE"]}' -> --doc-types bitable
- lark-sheets/SKILL.md: body + frontmatter description, add drive-search ref link
Same server API, equivalent capability; only flattens the entry from
nested --filter JSON to flags. reference links repointed to lark-drive.
2. Fix creator_ids/--mine semantic: creator -> owner
The server matches creator_ids (incl. --mine / --creator-ids) by owner
(document owner), not original creator, despite the OpenAPI field name.
- shortcuts/drive/drive_search.go: --help Desc and Tip
- lark-drive/references/lark-drive-search.md: identity section, params, rules, examples
- lark-drive/SKILL.md: top-level guidance
- lark-doc/references/lark-doc-search.md: creator_ids usage note (now self-consistent)
Wire field name creator_ids kept (aligned with the server).
Docs/help strings only, no logic change; gofmt / go vet / package build pass.
Change-Id: If3ebf5a247b7e38b58050c677dc888a310f1c6b6
168850c to
9ed4a1d
Compare
Background
docs +searchis in maintenance and will be removed; cloud-space resource discovery is consolidated ontodrive +search. This PR makes two related documentation/help-text quality fixes.Changes
1. Redirect guidance: docs +search → drive +search
Switch the skills/templates that still actively steer users to
docs +searchover todrive +search(the already-correct "deprecated" notices and the B-class fallback doclark-doc-search.mdare left as-is):skill-template/domains/{doc,sheets}.mdskills/lark-base/SKILL.md:--filter '{"doc_types":["BITABLE"]}'→--doc-types bitable; reference link repointed tolark-driveskills/lark-sheets/SKILL.md: body + frontmatterdescription, adddrive-searchreference linkBoth hit the same server API (
POST /open-apis/search/v2/doc_wiki/search) with equivalent capability; this only flattens the entry from nested--filterJSON to flags.2. Fix creator_ids/--mine semantic: creator → owner
The server matches search
creator_ids(incl.--mine/--creator-ids) by owner (document owner) semantics — despite the OpenAPI field namecreator, it is not the original creator (a doc created then transferred out won't match; one transferred to me will). Corrected the misleading wording:shortcuts/drive/drive_search.go:--helpDesc and Tip for--mine/--creator-ids(user-visible)skills/lark-drive/references/lark-drive-search.md: identity section, param table, decision rules, examplesskills/lark-drive/SKILL.md: top-level guidanceskills/lark-doc/references/lark-doc-search.md:creator_idsusage note (now consistent with the same file's "owner" wording)The wire field name
creator_idsis kept unchanged (aligned with the server).Impact / Validation
gofmt -lclean,go vet ./shortcuts/drive/passes, package buildscreator_id/creatorinlark-base/*workflow*,lark-vc-notes,lark-task— genuine "creator" fields of other, unrelated APIsSummary by CodeRabbit
--mineas owner-based (documents you own) and--creator-ids/creator_idsas owner open_id matching; they are mutually exclusive.drive +searchreturns SHEET results and to switch to the corresponding app (e.g., sheets) after locating a spreadsheet.