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
Copy link
Copy Markdown
Collaborator

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

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

Related Issues

  • None

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added comprehensive documentation for new IM API resources enabling chat management and moderation capabilities. New endpoints include chat manager administration (add_managers, delete_managers) and moderation operations (get, update). Documentation covers required permission scopes and identity constraints for developers.

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
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d2d65c23-9eb9-462b-9970-ec50b9aa0689

📥 Commits

Reviewing files that changed from the base of the PR and between 37b17f3 and 3fc9541.

📒 Files selected for processing (1)
  • skills/lark-im/SKILL.md

📝 Walkthrough

Walkthrough

This PR adds documentation for two new IM API resource sections: chat.managers with add_managers and delete_managers methods, and chat.moderation with get and update methods. Identity constraints and authorization requirements are documented, and corresponding permission scope mappings are added to the permissions table.

Changes

IM API Resources and Permissions

Layer / File(s) Summary
Chat managers and moderation API resources with permissions
skills/lark-im/SKILL.md
New API resource sections document chat.managers and chat.moderation methods with supported identities and authorization constraints. Permission scope mappings (im:chat.managers:write_only, im:chat.moderation:read, im:chat.moderation:write_only) are added to the permissions table.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

domain/im, size/M

Suggested reviewers

  • liangshuo-1
  • YangJunzhou-01

Poem

🐰 Two new chat resources bloom today,
Managers and moderation lead the way,
Permissions mapped with careful thought,
An IM feature nicely wrought!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: documenting two new API resource sections (chat.managers and chat.moderation) in the lark-im skill.
Description check ✅ Passed The description matches the template structure with all required sections (Summary, Changes, Test Plan, Related Issues) properly filled out with clear details about the documentation updates.
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.

@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
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

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

@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.39%. Comparing base (a75420f) to head (3fc9541).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1294      +/-   ##
==========================================
+ Coverage   70.33%   70.39%   +0.06%     
==========================================
  Files         672      677       +5     
  Lines       65322    65599     +277     
==========================================
+ Hits        45941    46176     +235     
- Misses      15728    15757      +29     
- Partials     3653     3666      +13     

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

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