[Gap]: Document displayName on AI Gateway routes
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 85/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- yaml
调研方向
从 Model routing 页面开始，该页面列出了路由字段；再看 Providers and models 页面，issue 称该页面遗漏了此字段。文案请参考 aigateways.ai-gateway.stacklok.dev 上 spec.routes[].displayName 的 CRD 描述。在路由字段列表中添加一行条目，并在 YAML 示例中添加一行 displayName。当两个页面都提到该字段、它回退到模型 ID 的行为以及 253 个字符的上限时，即为完成。
由索引模型根据 Issue 内容生成。
描述
What needs documentation?
The displayName field on spec.routes[] of the AIGateway resource. The CRD accepts it, but the Model routing page lists only name, match.model and backendRefs, and the field doesn't appear on Providers and models either.
The CRD describes it as the human-readable label surfaced to model-discovery clients, such as Claude Code's model picker, through the display_name field of GET /v1/models. When it's empty, the operator falls back to the route's model id. The maximum length is 253 characters.
Context and references
The CRD field description on aigateways.ai-gateway.stacklok.dev (spec.routes[].displayName). The page needs a one-line mention in the route fields list and ideally a displayName in the YAML example, for instance:
routes:
- name: claude-sonnet-5.5
displayName: Claude Sonnet 5.5
match:
model: anthropic/claude-sonnet-5.5
backendRefs:
- provider: openrouter
Use case
Operators who expose models through the gateway want clients with a model picker to show readable names instead of raw slugs like anthropic/claude-sonnet-5.5. Without a mention in the docs, the field is only discoverable by reading the CRD.
- 主要语言
- TypeScript
- 星标
- 4
- 派生
- 4
- 平均合并
- 1 天 1 小时
- 30 天内合并 PR
- 60
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
stacklok/docs-website 的其他 Issue
-
bug documentation needs-triage
难度 2/5 1-3 小时 新手友好度 72/100
stacklok/docs-website#1149 · 2 条评论 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 68/100
stacklok/docs-website#1143 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 72/100
stacklok/docs-website#564 · 1 条评论 ·
维护者通常 1 天内回复
-
documentation enhancement needs-triage
难度 4/5 3-5 天 新手友好度 55/100
stacklok/docs-website#1159 · 1 条评论 ·
维护者通常 1 天内回复
-
documentation enhancement needs-triage
难度 3/5 1-2 天 新手友好度 48/100
stacklok/docs-website#1148 · 2 条评论 ·
维护者通常 1 天内回复
查看 stacklok/docs-website 的全部 Issue
相似的 Issue
-
area:ui effort:S enhancement priority:P2
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 74/100
QuantumNous/new-api#7839 ·
维护者通常 1 天内回复
-
good first issue maintenance
难度 2/5 1-3 小时 新手友好度 62/100
dark-princezz/stellar-hooks#1010 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
interledger/rhyza#352 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复