Skip to content

docs(im): add feed.groups skill reference#1100

Closed
zhumiaoxin wants to merge 1 commit into
larksuite:mainfrom
zhumiaoxin:feat/feed-group
Closed

docs(im): add feed.groups skill reference#1100
zhumiaoxin wants to merge 1 commit into
larksuite:mainfrom
zhumiaoxin:feat/feed-group

Conversation

@zhumiaoxin

@zhumiaoxin zhumiaoxin commented May 26, 2026

Copy link
Copy Markdown
Collaborator

Document the nine raw-API methods registered under the feed.groups resource: create, update, delete, batch_query, list, batch_add_item, batch_remove_item, batch_query_item, list_item. Adds a new high-density skill reference at skills/lark-im/references/lark-im-feed-groups.md and records the matching permission scopes in skills/lark-im/SKILL.md.

The new reference covers, for each method:

  • HTTP verb, path, and request/response shape
  • The enum surface from the underlying datasync IDL (feed_group_type, feed_card_type, rule action / match / condition item / operator / chat type, update_fields)
  • A feed_group_rules JSON walkthrough with the required-field legend

The chat-only constraint on items[].feed_type is called out loudly: the meta types feed_type as an open string and the CLI does not pre-validate, so the per-method tables and the feed_card_type enum section both make clear that anything other than "chat" is rejected at runtime.

All fenced JSON blocks parse cleanly so examples are paste-runnable into --data.

Also refines descriptions for +flag-create / +flag-cancel — a carried-over wording fix from the prior IM bookmark task that was sitting uncommitted on this branch.

Change-Id: I4d64853276a20ac649c4041d7a5d26f3839932f7

Summary

Changes

  • Change 1
  • Change 2

Test Plan

  • Unit tests pass
  • Manual local verification confirms the lark-cli <domain> <command> flow works as expected

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified shortcut help: +flag-create now notes feed-layer item_type is auto-detected from chat_mode; +flag-cancel describes a best-effort double-cancel (message layer and feed layer when determinable)
    • Added comprehensive feed.groups API reference with methods, request/response shapes, enums, and usage notes
    • Expanded permissions table to include feed.groups.* scopes

Review Change Stack

@CLAassistant

CLAassistant commented May 26, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added domain/im PR touches the im domain size/L Large or sensitive change across domains or core paths labels May 26, 2026
@coderabbitai

coderabbitai Bot commented May 26, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fb74782f-8151-4362-83e4-7a02c49f891d

📥 Commits

Reviewing files that changed from the base of the PR and between 69e9e79 and 7461ee2.

📒 Files selected for processing (4)
  • shortcuts/im/im_flag_cancel.go
  • shortcuts/im/im_flag_create.go
  • skills/lark-im/SKILL.md
  • skills/lark-im/references/lark-im-feed-groups.md

📝 Walkthrough

Walkthrough

This PR clarifies IM flag shortcut behavior (best-effort double-cancel and feed item_type auto-detection) and adds a full feed.groups API reference plus corresponding permission scope entries.

Changes

IM Feed-Related Updates

Layer / File(s) Summary
Flag Shortcut Behavior Clarification
shortcuts/im/im_flag_cancel.go, shortcuts/im/im_flag_create.go, skills/lark-im/SKILL.md
ImFlagCancel description updated to clarify best-effort double-cancel (removes message layer and conditionally removes feed layer when chat_type is determinable). ImFlagCreate description clarified that feed-layer item_type is auto-detected from chat_mode when using --flag-type feed. SKILL.md updated accordingly.
Feed Groups API Documentation
skills/lark-im/SKILL.md, skills/lark-im/references/lark-im-feed-groups.md
Added feed.groups API section in SKILL.md and a comprehensive reference document covering methods (create, update, delete, batch_query, list, batch_add_item, batch_remove_item, batch_query_item, list_item), request/response schemas, enums, and permission scope mappings to im:feed_group_v1:*.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • larksuite/cli#770: Introduced the flag-layer and double-cancel semantics that these shortcut descriptions document and clarify.

Suggested reviewers

  • YangJunzhou-01
  • haozhenghua-code
  • fangshuyu-768

Poem

🐰 I hopped through flags and feeds tonight,
Clarified layers, made descriptions bright,
Feed groups penned with tidy rule,
Bookmarks behave as docs now school,
A little rabbit cheers the light.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete. While it contains a detailed custom summary of the changes, it is missing the required template sections: explicit 'Changes' bullet list, 'Test Plan' checklist, and 'Related Issues' section. Restructure the description to follow the template: add a 'Changes' section with bullet points, include the 'Test Plan' checklist, and complete the 'Related Issues' section properly.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding documentation (skill reference) for the feed.groups API resource.
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.

@codecov

codecov Bot commented May 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.92%. Comparing base (ee9d090) to head (69e9e79).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1100   +/-   ##
=======================================
  Coverage   67.92%   67.92%           
=======================================
  Files         601      601           
  Lines       55766    55766           
=======================================
  Hits        37880    37880           
  Misses      14751    14751           
  Partials     3135     3135           

☔ 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

github-actions Bot commented May 26, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@7461ee2e1b91705ed4e90373ecc81182606e1d60

🧩 Skill update

npx skills add zhumiaoxin/cli#feat/feed-group -y -g

Change-Id: I036dee54c443fc13ca9515e1f2699dcf9851908e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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