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

[shifengjuan-dev]

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.get → im:chat.nickname:read
  • chat.nickname.update → im:chat.nickname:write
  • chat.nickname.delete → im: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 comprehensive documentation for chat nickname IM API resource with methods to retrieve, update, and remove user nicknames, including size constraints and behavior specifications.

• New Features

  • Enabled chat nickname management functionality with corresponding read/write permission scopes for secure API access and identity management.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 385752fc-fa82-4413-a9b4-d0ce636c5d3c

📥 Commits

Reviewing files that changed from the base of the PR and between af9f8e2 and ac3b27a.

📒 Files selected for processing (2)

• internal/registry/scope_priorities.json
• skills/lark-im/SKILL.md

🚧 Files skipped from review as they are similar to previous changes (1)

• skills/lark-im/SKILL.md

---

📝 Walkthrough

Walkthrough

Adds documentation for the chat.nickname IM API resource with three self-only methods (get, update, delete) and corresponding permission scope entries in the skills doc, and registers scope priority values for im:chat.nickname:read, im:chat.nickname:write, and im:chat.user_setting:write in the registry.

Changes

Chat nickname API documentation and scope configuration

Layer / File(s)	Summary
Chat nickname API methods and permissions skills/lark-im/SKILL.md	Adds a ### chat.nickname section documenting self-only get, update, and delete methods with identity requirements, empty-string behavior, 300-byte size limit, and clearing via DELETE. Extends the permissions table with chat.nickname.get, chat.nickname.update, and chat.nickname.delete mapped to im:chat.nickname:read / im:chat.nickname:write.
Scope priority registry entries internal/registry/scope_priorities.json	Inserts three new scope-priority JSON objects for im:chat.nickname:read, im:chat.nickname:write, and im:chat.user_setting:write, each with a final_score and recommend: true.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• larksuite/cli#1050: Also adds new IM-related scope-priority entries to internal/registry/scope_priorities.json at the same registry data level.

Suggested reviewers

• YangJunzhou-01
• liangshuo-1

Poem

A rabbit hops into the chat one day,
Sets a nickname, then clears it away.
With get, update, and delete in line,
The scopes are registered — all looking fine!
🐇 Max 300 bytes, and I'm doing great!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description covers What and Why sections clearly, but is missing the required Changes list and Test Plan section from the template.	Add a Changes section listing the modifications and a Test Plan section confirming how this documentation change was verified.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: documenting the chat.nickname resource with its three methods (get/update/delete).
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

⚔️ Resolve merge conflicts

• Resolve merge conflict in branch feat/im-chat-nickname

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

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]

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

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