Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[Gap]: Document displayName on AI Gateway routes

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#1,241 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
85/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
yaml
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu từ trang Model routing, nơi liệt kê các trường của route, và trang Providers and models, nơi theo issue thì thiếu trường này. Lấy cách diễn đạt từ mô tả CRD của spec.routes[].displayName trên aigateways.ai-gateway.stacklok.dev. Thêm một mục một dòng vào danh sách trường của route và một dòng displayName trong ví dụ YAML. Hoàn thành khi cả hai trang đều đề cập đến trường này, cơ chế dùng model id khi thiếu, và giới hạn 253 ký tự.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement needs-triage
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.

Ngôn ngữ chính
TypeScript
Star
4
Fork
4
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
58

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stacklok/docs-website

Tất cả issue của stacklok/docs-website

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.