Skip to content

docs(im): document chat.managers and chat.moderation API resources#1294

Open
shifengjuan-dev wants to merge 1 commit into
larksuite:mainfrom
shifengjuan-dev:feat/chat-managers-moderation
Open

docs(im): document chat.managers and chat.moderation API resources#1294
shifengjuan-dev wants to merge 1 commit into
larksuite:mainfrom
shifengjuan-dev:feat/chat-managers-moderation

Conversation

@shifengjuan-dev

@shifengjuan-dev shifengjuan-dev commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

Document the group-manager and group-moderation (speaking-permission) API-meta resources in the lark-im skill so they are discoverable for the lark-cli im <resource> <method> flow. Docs-only; the resource definitions already ship via the generated registry.

Changes

  • Add ### chat.managers API Resources section: add_managers (指定群管理员), delete_managers (删除群管理员).
  • Add ### chat.moderation API Resources section: get (查询群成员发言权限), update (更新群发言权限).
  • Add the four corresponding scope rows to the permission table (im:chat.managers:write_only, im:chat.moderation:read, im:chat:moderation:write_only).

Test Plan

  • go build ./... passes
  • Manual local verification: lark-cli schema im.chat.managers.add_managers / delete_managers and im.chat.moderation.get / update all resolve with the expected params, body, and output fields

Summary by CodeRabbit

  • Documentation
    • Added documentation for new IM API resources enabling chat management and moderation. New endpoints: chat manager administration (add/delete managers) and moderation operations (get/update). Includes supported identity types, caller eligibility/authorization details, and updated permission-scope mappings for these actions.

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds documentation sections for two IM API resources: chat.managers (add_managers, delete_managers) and chat.moderation (get, update), and extends the permissions table with the corresponding scope mappings.

Changes

IM API Resources and Permissions

Layer / File(s) Summary
Chat managers and moderation API resources with permissions
skills/lark-im/SKILL.md
Adds docs for chat.managers (add_managers, delete_managers) and chat.moderation (get, update) including supported identities and authorization constraints; updates the permissions table with im:chat.managers:write_only, im:chat.moderators:read, and im:chat.moderation:write_only scope mappings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

domain/im, size/M

Suggested reviewers

  • YangJunzhou-01
  • liangshuo-1

Poem

🐰 New docs sprout in fields of code,
Managers and moderation take the road,
Scopes aligned, permissions clear,
Little rabbit gives a cheer,
Hops away with tidy ode.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change—documenting chat.managers and chat.moderation API resources—and is clear, concise, and specific.
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.
Description check ✅ Passed The pull request provides a clear summary, detailed changes, completed test plan with checkmarks, and follows the required template structure.

✏️ 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/im PR touches the im domain size/M Single-domain feat or fix with limited business impact labels Jun 5, 2026
@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add shifengjuan-dev/lark-cli#feat/chat-managers-moderation -y -g

@codecov

codecov Bot commented Jun 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.58%. Comparing base (03ea6e7) to head (be3bfde).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1294   +/-   ##
=======================================
  Coverage   71.58%   71.58%           
=======================================
  Files         689      689           
  Lines       65521    65521           
=======================================
  Hits        46901    46901           
  Misses      14972    14972           
  Partials     3648     3648           

☔ View full report in Codecov by Harness.
📢 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.

Add SKILL.md entries for the group manager and group moderation
(speaking-permission) API-meta resources:
- chat.managers.add_managers / delete_managers (指定/删除群管理员)
- chat.moderation.get / update (查询/更新群发言权限)

Includes the API Resources descriptions and the permission-table scope
rows. Invoked via lark-cli im chat.managers/chat.moderation <method>.

Change-Id: If269f72d572f276972366bdd4bb97b387dd9ec1d
@shifengjuan-dev shifengjuan-dev force-pushed the feat/chat-managers-moderation branch from 3fc9541 to be3bfde Compare June 9, 2026 07:09
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/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant