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

feat: support external $ref resolution in OpenAPI loader

Abierto
#130 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
openapi, typescript
Área
api

Línea de trabajo

Comienza en src/lib/openapi.ts siguiendo el manejo de $ref externos y la conversión de V2→V3. Comprueba cómo se resuelven las referencias en relación con el archivo de especificación y verifica después que consumes/produces se conviertan en entradas de content-type y que se cubran las carencias de conversión indicadas. El trabajo estará terminado cuando las referencias externas ya no queden sin resolver en la documentación de API renderizada y se conserven los campos V2 especificados.

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

Descripción

Problem

`src/lib/openapi.ts` only resolves internal `#/` JSON pointer references. External file references (e.g. `$ref: './common/errors.yaml'`) fail silently, resulting in unresolved `$ref` objects appearing in the rendered API docs.

The V2→V3 conversion is also incomplete:

  • Ignores `consumes`/`produces` fields (assumes JSON for everything)
  • Doesn't convert all security scheme types
  • Missing request/response examples

Suggested Fix

  • For external file refs, resolve relative to the spec file's directory
  • For the V2 conversion, carry over `consumes`/`produces` as content type entries in V3 request/response objects
Lenguaje dominante
TypeScript
Estrellas
2
Forks
1
Merge medio
12 min
PR fusionados (30 d)
1

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 raystack/chronicle

Todos los issues de raystack/chronicle

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.