Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[Gap]: Document displayName on AI Gateway routes

Abierto Apto para principiantes
  • ¿Algo no está bien?
#1,241 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
85/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
yaml
Área
documentation

Línea de trabajo

Empieza por la página Model routing, que enumera los campos de ruta, y por la página Providers and models, que según el issue omite el campo. Toma la redacción de la descripción del CRD de spec.routes[].displayName en aigateways.ai-gateway.stacklok.dev. Añade una entrada de una línea a la lista de campos de ruta y una línea displayName en el ejemplo YAML. Está terminado cuando ambas páginas mencionan el campo, su alternativa al ID del modelo y el límite de 253 caracteres.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
JavaScript
Estrellas
4
Forks
4
Merge medio
1 d 1 h
PR fusionados (30 d)
58

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stacklok/docs-website

Todos los issues de stacklok/docs-website

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.