Skip to content

docs(im): document chat.nickname get/update/delete#1378

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

docs(im): document chat.nickname get/update/delete#1378
shifengjuan-dev wants to merge 1 commit into
larksuite:mainfrom
shifengjuan-dev:feat/im-chat-nickname

Conversation

@shifengjuan-dev

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

Copy link
Copy Markdown
Collaborator

What

Document the chat.nickname resource in the lark-im skill doc.

  • Add a ### chat.nickname section covering get / update / delete (self-only, user identity / user_access_token).
  • Add the dedicated scope mappings to the scope table:
    • chat.nickname.getim:chat.nickname:read
    • chat.nickname.updateim:chat.nickname:write
    • chat.nickname.deleteim:chat.nickname:write

Why

The chat.nickname resource already exists in internal/registry/meta_data.json (GET/PUT/DELETE /open-apis/im/v1/chats/{chat_id}/nickname) but was undocumented in the skill. This brings the doc in line with the registry. Scopes match the method definitions in meta_data.json.

Docs-only change; no code or registry modification.

Summary by CodeRabbit

  • Documentation
    • Added documentation for three new IM API methods to manage chat nicknames: get, update, and delete. These methods allow users to manage their own nicknames within chats.
    • Added corresponding permission scopes for nickname operations in the permissions reference table.

Add chat.nickname resource section (self-only, user identity) and its
dedicated scope mappings (im:chat.nickname:read / im:chat.nickname:write)
to the lark-im skill doc.

Change-Id: I066b10f010a660438275d66932a497b9501c26de
@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds documentation for a new chat.nickname IM API resource with three self-only methods (get, update, delete) to manage group chat nicknames, and extends the permissions table with corresponding read/write scopes.

Changes

Chat nickname API documentation

Layer / File(s) Summary
Chat nickname API and permissions
skills/lark-im/SKILL.md
New chat.nickname API resource documented with three methods: get (retrieve self nickname), update (set self nickname with non-empty constraint), and delete (clear self nickname). Permissions table extended with chat.nickname.get, chat.nickname.update, and chat.nickname.delete scopes mapped to im:chat.nickname:read and im:chat.nickname:write.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

domain/im, size/M

Suggested reviewers

  • YangJunzhou-01
  • MaxHuang22

Poem

🐰 A nickname for chats, now documented with care,
Three methods to manage, permission scopes rare,
Get, update, delete—self-service so fine,
The API is ready, let the docs align! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: adding documentation for three chat.nickname API methods (get/update/delete) in the IM module.
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 PR description clearly explains the motivation (documenting existing undocumented API), lists specific changes (chat.nickname section and scope mappings), but lacks a Test Plan section from the template.

✏️ 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 10, 2026
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.97%. Comparing base (03ea6e7) to head (02cfbed).
⚠️ Report is 29 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1378      +/-   ##
==========================================
+ Coverage   71.58%   71.97%   +0.39%     
==========================================
  Files         689      696       +7     
  Lines       65521    65891     +370     
==========================================
+ Hits        46901    47424     +523     
+ Misses      14972    14811     -161     
- Partials     3648     3656       +8     

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

@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add shifengjuan-dev/lark-cli#feat/im-chat-nickname -y -g

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