Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[Gap]: Document displayName on AI Gateway routes

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,241 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
yaml
Ambito
documentation

Direzione di ricerca

Inizia dalla pagina Model routing, che elenca i campi delle route, e dalla pagina Providers and models, che secondo la issue omette il campo. Riprendi la formulazione dalla descrizione CRD di spec.routes[].displayName su aigateways.ai-gateway.stacklok.dev. Aggiungi una voce su una riga all'elenco dei campi delle route e una riga displayName nell'esempio YAML. È completato quando entrambe le pagine menzionano il campo, il suo fallback sull'ID del modello e il limite di 253 caratteri.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
4
Fork
4
Merge medio
1g 1h
PR unite (30g)
58

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stacklok/docs-website

Tutte le issue di stacklok/docs-website

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.