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

Provide guidance on using OAS with Overlay and Arazzo

Abierto
#4,221 3 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
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
markdown

Línea de trabajo

Comienza comparando el OAS Link Object con las especificaciones Arazzo y Overlay, centrándote en los casos de uso descritos en el issue. Se considerará terminado cuando se haya añadido una guía clara de OAS sobre cuándo usar cada especificación, incluidos los valores globales o predeterminados y las construcciones de reference-and-modify.

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

Descripción

clarification

Many long-requested features for OAS can now be better handled by using the Overlay and/or Arazzo specifications.

I think Arazzo mostly overlaps with the Link Object, but I might be wrong there. Some guidance as to when to use which would probably be good to add.

Overlays solve many requests for global or default values, and if it is reasonably straightforward to do that, we should include info in the OAS pointing to the Overlay spec for that use case. Other use cases include various reference-and-modify constructs (hmm.. do we want to consider pushing this instead of the adjacent-fields-in-Reference-Object approach?)

Putting this in the next patch release, although there may be additional things to do in minor releases here.

Lenguaje dominante
Markdown
Estrellas
31.2k
Forks
9.2k
Merge medio
2 d 9 h
PR fusionados (30 d)
17

Preparar el entorno

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 OAI/OpenAPI-Specification

Todos los issues de OAI/OpenAPI-Specification

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.