docs: admin users create のヘルプをAPI仕様に合わせて改善#77
Merged
Conversation
- JSON payload example に tenantId フィールドを追加 - 有効なロール一覧(super_admin, tenant_admin, user)を記載 - tenantId の必須条件を説明に追記 - Examples から super_admin の例を削除し、tenant_admin / user の例を追加
📝 WalkthroughWalkthrough
Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3分 Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/commands/admin/users.ts (1)
108-108: ロール値の不整合更新コマンドの例で使用されている
"role": "admin"が、作成コマンドで文書化された有効なロール(super_admin, tenant_admin, user)と一致していません。一貫性を保つため、この例も有効なロール値のいずれかに更新することを検討してください。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/commands/admin/users.ts` at line 108, The example update payload in src/commands/admin/users.ts uses an invalid role value ("admin"); change that example (the string ' e.g. {"role": "admin"}') to use one of the documented valid roles (e.g. "tenant_admin", "super_admin", or "user") so it matches the create command documentation and remains consistent; update the example to a specific valid value such as ' e.g. {"role": "tenant_admin"}' wherever the update command example is defined.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/commands/admin/users.ts`:
- Line 108: The example update payload in src/commands/admin/users.ts uses an
invalid role value ("admin"); change that example (the string ' e.g. {"role":
"admin"}') to use one of the documented valid roles (e.g. "tenant_admin",
"super_admin", or "user") so it matches the create command documentation and
remains consistent; update the example to a specific valid value such as ' e.g.
{"role": "tenant_admin"}' wherever the update command example is defined.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: de15cc40-835c-412b-98f4-1683e9d8981c
📒 Files selected for processing (1)
src/commands/admin/users.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
geonic admin users createのヘルプ表示をGeonicDBサーバーの実装に合わせて修正tenantIdフィールドを追加し、有効なロール一覧を記載super_adminの例を削除し、tenant_admin(テナント管理者)とuser(一般ユーザー)の例を追加Test plan
npm run lintパスnpm run typecheckパスnpm test全624テストパスgeonic admin users create --helpで新しいヘルプ表示を確認Summary by CodeRabbit
ドキュメント