Support Overlays standard

Abierto
  • ¿Algo no está bien?
#981 2 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
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
openapi, python
Área
api

Línea de trabajo

Comienza leyendo la especificación vinculada de Overlays 1.0.0 y el proyecto openapi-overlays-js; después, inspecciona cómo apispec genera y expone su definición de OpenAPI. Aclara si el resultado deseado es un paso integrado de combinación de overlays o un plugin compatible independiente incluido en la página Ecosystem.

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

Descripción

enhancement

There is a reasonably new formalised standard out called "Overlays - https://github.com/OAI/Overlay-Specification/blob/main/versions/1.0.0.md 2024-10-17 .

Currently, I can generate my openapi definition from the code, then add a few tweaks to it, commit this to a documentation site, but the second the source code changes, then one has to manually add in the tweaks again, repeat this process for every update.

This standard helps a lot with that, since now, using something like - https://github.com/lornajane/openapi-overlays-js - then any additional changes can be kept in a seperate file, then added back in when we want to add it.

Currently, if there is an issue with the generator, or you just want to add in some new properties to the auto-generated code, then you either have to fix this repo or then use a 3rd party tool to then join the two back together again.

Might be nice to add in an overlay merging step, but if this is outside the scope of this project, then that's also fine since adding more features (even if pulling in a library for most of it) does distract from the main scope of this project.

Or probably one to make a plugin that is compatible with this library and then can be added to the Ecosystem page?

Lenguaje dominante
Python
Estrellas
1.2k
Forks
210
Merge medio
2 d 1 h
PR fusionados (30 d)
4

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 marshmallow-code/apispec

Todos los issues de marshmallow-code/apispec

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.