[REQ/PROPOSAL/OFFER TO IMPLEMENT] - Native OpenAPI Overlay Support

Abierto
#25,661 1 comentario 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
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

Enhancement: Feature
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, or x-spring-paginated without modifying the source specification.
  • Customize schemas: Add missing properties, change property types, rename properties, or adjust required constraints.
  • 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

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 OpenAPITools/openapi-generator

Todos los issues de OpenAPITools/openapi-generator

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.