[REQ/PROPOSAL/OFFER TO IMPLEMENT] - Native OpenAPI Overlay Support
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 22/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- java, openapi
- Domaine
- api, build-system
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Java
- Étoiles
- 26.9k
- Forks
- 7.8k
- Merge moyen
- 2 j 23 min
- PR mergées (30 j)
- 177
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OpenAPITools/openapi-generator
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25768 ·
Les mainteneurs répondent en général sous 1 jour
-
Enhancement: Feature
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25753 ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
OpenAPITools/openapi-generator#25724 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25723 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePeut-être pris @Inf1mum l’a pris il y a 2 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25719 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OpenAPITools/openapi-generator
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
eclipse-tradista/tradista#371 ·
Les mainteneurs répondent en général sous 1 jour
-
Failed to start Rescue missionOuvertecritical
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
mars-sim/mars-sim#2199 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
primefaces/primefaces#15568 ·
Les mainteneurs répondent en général sous 1 jour
-
崩溃日志只按 CRLF 分行Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
PCL-Community/PCL-CE#3872 ·
Les mainteneurs répondent en général sous 1 jour