OpenAPITools / OpenAPITools/openapi-generator

[REQ] Inherit encapsulating maven properties

Open
#20,253 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

When doing Java contract first development, generating a pom file is rather superfluous. One just want to get the generated code artifacts and no more. However there's sometimes beneficial to have access to the generating project's (or module's) artifactId version and so on that are ubiquitous to any Maven project. The unfortunate part is that artifactId and version is available as arguments to the openapi-generator-maven-plugin but only if explicitly specified in the pom file.

Describe the solution you'd like

Where the current implementation in CodeGenMojo looks like

            if (isNotEmpty(artifactId)) {
                configurator.setArtifactId(artifactId);
            }

It seems like an implicit alternative would be in order i.e.

            if (isNotEmpty(artifactId)) {
                configurator.setArtifactId(artifactId);
            } else {
                configurator.setArtifactId(project.getArtifactId());
            }

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in modules/openapi-generator-maven-plugin/src/main/java/org/openapitools/codegen/plugin/CodeGenMojo.java, at the artifactId configuration shown in the issue. Trace how the Maven project is exposed to the plugin and how configurator properties reach generated artifacts. Done means project properties such as artifactId and version are inherited when plugin arguments are omitted.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.