[REQ/PROPOSAL/OFFER TO IMPLEMENT] - Native OpenAPI Overlay Support
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
- 22/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- java, openapi
- Área
- api, build-system
Línea de trabajo
The payload names no source files. Start by reading how the generator loads and parses the input spec before code generation, since overlays must be applied at that point, and how the CLI, Gradle and Maven plugins pass the spec in. The author wants maintainers to agree on the integration approach (for example the overlay-jvm dependency) before any code is written, so check for a reply first. Done means one or more overlay files are applied before parsing, with tests across the CLI and build plugins.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Is your feature request related to a problem? Please describe.
Customizing OpenAPI specifications for code generation currently requires modifying the original spec, using generator-specific configuration options, or introducing external preprocessing steps.
This is particularly relevant when dealing with imperfect or non-compliant OpenAPI specifications that cannot be modified at their source.
Additionally, some generators already provide complex configuration options to inject vendor extensions without modifying the original specification. A standardized overlay mechanism could reduce the need to implement and maintain such generator-specific workarounds.
Describe the solution you'd like
Support the OpenAPI Overlay Specification natively, allowing one or more overlay files to be passed alongside the original specification.
Overlays should be applied before parsing and code generation, with support across CLI, Gradle, and Maven integrations.
This would enable users to:
- Inject vendor extensions: Add
x-implements,x-class-extra-annotation, orx-spring-paginatedwithout modifying the source specification. - Customize schemas: Add missing properties, change property types, rename properties, or adjust
requiredconstraints. - Work around problematic specifications: Fix incorrect schema definitions, missing metadata, or other issues in externally maintained OpenAPI documents.
- Customize operations: Add annotations, modify parameters, or exclude certain endpoints from generation.
- Apply cross-cutting customizations: Use JSONPath expressions to apply common metadata or modifications across multiple schemas or operations.
It could also reduce the maintenance burden on OpenAPI Generator by providing a standardized alternative to generator-specific configuration options such as schemaImplements or typeInfoDefaultImpls, where equivalent vendor extensions already exist.
Describe alternatives you've considered
External preprocessing using tools such as Redocly CLI or custom build tasks.
Additional context
overlay-jvm could be a suitable implementation dependency because it:
- Is written in Java and can integrate directly into the existing generator pipeline.
- Provides a simple API for applying overlays to OpenAPI documents.
- Supports JSON/YAML and standards-based JSONPath expressions.
- Implements OpenAPI Overlay Specification 1.1.0.
- Avoids introducing external tools or runtimes into the generation workflow.
Its focused scope could make integration relatively straightforward, although compatibility with newer Overlay Specification versions would need consideration.
I'd be willing to work on implementing this feature and submit a PR, provided the maintainers are open to the approach. Feedback on the proposed integration and preferred architecture would be appreciated before proceeding.
But of course sticking to custom pre-processing step also works. It just seems like such a natural fit, hence the proposal.
- Lenguaje dominante
- Java
- Estrellas
- 26.9k
- Forks
- 7.8k
- Merge medio
- 2 d 23 min
- PR fusionados (30 d)
- 177
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OpenAPITools/openapi-generator
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OpenAPITools/openapi-generator#25768 ·
Los mantenedores suelen responder en 1 día
-
Enhancement: Feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OpenAPITools/openapi-generator#25753 ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPosiblemente ocupada @Inf1mum la tomó hace 2 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
OpenAPITools/openapi-generator#25724 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPosiblemente ocupada @Inf1mum la tomó hace 2 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
OpenAPITools/openapi-generator#25723 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePosiblemente ocupada @Inf1mum la tomó hace 2 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
OpenAPITools/openapi-generator#25719 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de OpenAPITools/openapi-generator
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
eclipse-tradista/tradista#371 ·
Los mantenedores suelen responder en 1 día
-
Failed to start Rescue missionAbiertocritical
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
mars-sim/mars-sim#2199 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
primefaces/primefaces#15568 ·
Los mantenedores suelen responder en 1 día
-
崩溃日志只按 CRLF 分行Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
PCL-Community/PCL-CE#3872 ·
Los mantenedores suelen responder en 1 día