完善api文档

[RecoveryAshes]

请完善api文档，好多都不能直接看文档调用api接口。比如创建密钥修改密钥分组等等

[github-actions]

Thank you for your feedback regarding the API documentation.

Based on my analysis of the codebase, I have identified the following issues with the current API documentation:

Current Situation

The API documentation is automatically generated from the route definitions in:

• src/app/api/actions/[...route]/route.ts

The documentation UI is available at:

• Swagger UI: /api/actions/docs
• Scalar UI: /api/actions/scalar

Identified Gaps

1. Missing Key Management Endpoints

The following server actions exist in src/actions/keys.ts but are NOT exposed via the API documentation:

Function	Description	Status
batchUpdateKeys	Batch update keys (including providerGroup)	Not exposed
toggleKeyEnabled	Toggle key enabled/disabled status	Not exposed
renewKeyExpiresAt	Quick renewal of key expiration	Not exposed
getKeysWithStatistics	Get keys with usage statistics	Not exposed

2. Incomplete Request Schemas for Existing Endpoints

The addKey and editKey endpoints (lines 258-313 in route.ts) are missing the providerGroup field in their request schemas, even though the underlying functions support it.

Current schema (lines 263-274):

requestSchema: z.object({
  userId: z.number().int().positive(),
  name: z.string(),
  expiresAt: z.string().optional(),
  canLoginWebUi: z.boolean().optional(),
  limit5hUsd: z.number().nullable().optional(),
  limitDailyUsd: z.number().nullable().optional(),
  limitWeeklyUsd: z.number().nullable().optional(),
  limitMonthlyUsd: z.number().nullable().optional(),
  limitTotalUsd: z.number().nullable().optional(),
  limitConcurrentSessions: z.number().optional(),
  // Missing: providerGroup, dailyResetMode, dailyResetTime, cacheTtlPreference, isEnabled
})

3. Missing User Management Endpoints

The following actions from src/actions/users.ts are also NOT exposed:

Function	Description	Status
batchUpdateUsers	Batch update users	Not exposed
getUsersBatch	Paginated user list	Not exposed
toggleUserEnabled	Toggle user enabled/disabled	Not exposed
renewUser	Renew user expiration	Not exposed
getAllUserTags	Get all user tags	Not exposed
getAllUserKeyGroups	Get all key groups	Not exposed

Workaround

Until the API documentation is completed, you can:

1. Use the Swagger/Scalar UI to test the currently exposed endpoints
2. Refer to src/actions/keys.ts and src/actions/users.ts for the full function signatures
3. Check the existing API authentication guide at docs/api-authentication-guide.md

Documentation References

• API route definitions: src/app/api/actions/[...route]/route.ts
• Key actions: src/actions/keys.ts (lines 88-1115)
• User actions: src/actions/users.ts
• Authentication guide: docs/api-authentication-guide.md
• Previous doc fix summary: docs/api-docs-summary.md

---

Automated response from Claude AI

[ding113]

您好，由于相关模块工作量较大，目前正在寻找 API 部分的维护者。
后续会逐步推进覆盖。