fix: API キーコマンドのヘルプに表示されるスコープ一覧を実際に使用可能な6スコープに修正 (#74)

Author: miya0001

CHANGELOG.md

@@ -7,6 +7,9 @@
 
 ## [Unreleased]
 
+### 2026-03-17
+- **Fix**: API キーコマンド (`me api-keys`, `admin api-keys`) のヘルプで表示されるスコープ一覧を、API キーで実際に使用可能な6スコープに修正 (#74)
+
 ## [0.6.3] - 2026-03-17
 
 ### 2026-03-17

src/commands/admin/api-keys.ts

@@ -4,7 +4,7 @@ import { loadConfig, saveConfig } from "../../config.js";
 import { parseJsonInput } from "../../input.js";
 import { printError, printWarning } from "../../output.js";
 import { addExamples, addNotes } from "../help.js";
-import { SCOPES_HELP_NOTES } from "../../helpers.js";
+import { API_KEY_SCOPES_HELP_NOTES } from "../../helpers.js";
 
 function validateOrigins(body: unknown, opts: Record<string, unknown>): void {
   // Validate origins if provided via flags
@@ -174,7 +174,7 @@ export function registerApiKeysCommand(parent: Command): void {
       }),
     );
 
-  addNotes(create, SCOPES_HELP_NOTES);
+  addNotes(create, API_KEY_SCOPES_HELP_NOTES);
 
   addExamples(create, [
     {
@@ -240,7 +240,7 @@ export function registerApiKeysCommand(parent: Command): void {
       ),
     );
 
-  addNotes(update, SCOPES_HELP_NOTES);
+  addNotes(update, API_KEY_SCOPES_HELP_NOTES);
 
   addExamples(update, [
     {

src/commands/me-api-keys.ts

@@ -4,7 +4,7 @@ import { loadConfig, saveConfig } from "../config.js";
 import { parseJsonInput } from "../input.js";
 import { printError, printWarning } from "../output.js";
 import { addExamples, addNotes } from "./help.js";
-import { SCOPES_HELP_NOTES } from "../helpers.js";
+import { API_KEY_SCOPES_HELP_NOTES } from "../helpers.js";
 
 export function addMeApiKeysSubcommand(me: Command): void {
   const apiKeys = me
@@ -128,7 +128,7 @@ export function addMeApiKeysSubcommand(me: Command): void {
       }),
     );
 
-  addNotes(create, SCOPES_HELP_NOTES);
+  addNotes(create, API_KEY_SCOPES_HELP_NOTES);
 
   addExamples(create, [
     {

src/helpers.ts

@@ -5,7 +5,7 @@ import { printError, printOutput, printCount } from "./output.js";
 import type { ClientResponse, GlobalOptions, OutputFormat } from "./types.js";
 
 /**
- * Valid scope values for --scopes option help text.
+ * Valid scope values for --scopes option help text (OAuth clients).
  */
 export const SCOPES_HELP_NOTES = [
   "Valid scopes:",
@@ -18,6 +18,15 @@ export const SCOPES_HELP_NOTES = [
   "write:X implies read:X. admin:X implies both read:X and write:X.",
 ];
 
+/**
+ * Valid scope values for --scopes option help text (API keys).
+ */
+export const API_KEY_SCOPES_HELP_NOTES = [
+  "Valid scopes:",
+  "  read:entities, write:entities, read:subscriptions, write:subscriptions,",
+  "  read:registrations, write:registrations",
+];
+
 /**
  * Resolve merged options from config + CLI flags.
  */

tests/admin-api-keys.test.ts

@@ -8,6 +8,7 @@ vi.mock("../src/helpers.js", () => ({
   outputResponse: vi.fn(),
   withErrorHandler: (fn: (...args: unknown[]) => unknown) => fn,
   SCOPES_HELP_NOTES: [],
+  API_KEY_SCOPES_HELP_NOTES: [],
   resolveOptions: vi.fn().mockReturnValue({ profile: "default" }),
 }));
 

tests/admin-oauth-clients.test.ts

@@ -8,6 +8,7 @@ vi.mock("../src/helpers.js", () => ({
   outputResponse: vi.fn(),
   withErrorHandler: (fn: (...args: unknown[]) => unknown) => fn,
   SCOPES_HELP_NOTES: [],
+  API_KEY_SCOPES_HELP_NOTES: [],
   resolveOptions: vi.fn(),
 }));
 

tests/admin-policies.test.ts

@@ -8,6 +8,7 @@ vi.mock("../src/helpers.js", () => ({
   outputResponse: vi.fn(),
   withErrorHandler: (fn: (...args: unknown[]) => unknown) => fn,
   SCOPES_HELP_NOTES: [],
+  API_KEY_SCOPES_HELP_NOTES: [],
   resolveOptions: vi.fn(),
 }));
 

tests/admin-tenants.test.ts

@@ -8,6 +8,7 @@ vi.mock("../src/helpers.js", () => ({
   outputResponse: vi.fn(),
   withErrorHandler: (fn: (...args: unknown[]) => unknown) => fn,
   SCOPES_HELP_NOTES: [],
+  API_KEY_SCOPES_HELP_NOTES: [],
   resolveOptions: vi.fn(),
 }));
 

tests/admin-users.test.ts

@@ -8,6 +8,7 @@ vi.mock("../src/helpers.js", () => ({
   outputResponse: vi.fn(),
   withErrorHandler: (fn: (...args: unknown[]) => unknown) => fn,
   SCOPES_HELP_NOTES: [],
+  API_KEY_SCOPES_HELP_NOTES: [],
   resolveOptions: vi.fn(),
 }));
 

tests/auth.test.ts

@@ -8,6 +8,7 @@ vi.mock("../src/helpers.js", () => ({
   outputResponse: vi.fn(),
   withErrorHandler: (fn: (...args: unknown[]) => unknown) => fn,
   SCOPES_HELP_NOTES: [],
+  API_KEY_SCOPES_HELP_NOTES: [],
   resolveOptions: vi.fn(),
 }));