Prhub

#40532 [Doc] Add missing API endpoints to security documentation

原始 PR 作者 russellb 合并时间 2026-04-29 05:53 文件变更 1 提交数 2 评论 1 代码增减 +26 / -5

执行摘要

补全安全文档缺失的 API 端点列表

安全文档中缺少多个实际存在的 API 端点,导致用户对哪些端点需要身份认证、哪些操作控制端点可被利用的理解不完整。PR body 明确指出:"Several endpoints were missing from the API key authentication limitations section: RLHF weight-manipulation endpoints, generative scoring, abort_requests, and various /v1 sub-paths."

建议合并,无代码风险。该 PR 是安全文档的及时补充,值得管理员和部署者阅读以了解最新 endpoint 列表和认证要求。

讨论亮点

审核来自 Claude 和 Gemini 的机器人自动评论,均未提出实质反馈;仓库维护者 sfeng33 直接批准。未发现人工评审讨论。

实现拆解

  1. 更新 API 密钥认证章节:在 docs/usage/security.md 中添加了 /v1/chat/completions/batch/v1/chat/completions/render/v1/completions/render/v1/messages/count_tokens/v1/responses/{response_id}/v1/responses/{response_id}/cancel/v1/load_lora_adapter/v1/unload_lora_adapter 等端点,并标注 LoRA 管理端点的开启条件和安全提示。
  2. 更新无需认证端点章节:添加 /generative_scoring/is_paused/is_scaling_elastic_ep/init_weight_transfer_engine/update_weights/get_world_size/abort_requests 等端点,并注明部分端点的前置条件(如 --tokens-only)。
  3. 修正操作控制端点描述:将 Operational control endpoints (always enabled) 改为 (only when "generate" task is supported),反映实际的行为依赖。
  4. 更新安全隐患描述:在安全影响部分补充了新增端点可能带来的攻击面(如权重操作、权重传输初始化和弹性缩放状态查询),并拆分 LoRA 端点作为单独警告段落(第二次提交新增)。
文件 模块 状态 重要度
docs/usage/security.md 文档 modified 3.19

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

该 PR 仅涉及文档修改,无代码变更,无回归、性能或安全风险。但若文档描述与实际行为不符(例如新的 endpoint 是否存在或条件描述有误),可能误导管理员的安全配置。

直接影响安全文档的完整性,帮助管理员正确配置 API 密钥认证和暴露范围;无用户功能变化或系统影响。

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论