OpenAPITools / OpenAPITools/openapi-generator

[REQ] maven plugin: remove `generateApis` and `apisToGenerate`

Open
#16,964 3 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

Problem

The openapi-generator-maven-plugin currently has 3 different options to influence which Apis will be generated: generateApis, apisToGenerate and globalProperties.apis. OpenAPI Generator itself only knows about globalProperties.apis. generateApis and apisToGenerate work by openapi-generator-maven-plugin modifying globalProperties.apis.

Some disadvantages with that:

Proposal

Therefore I propose to remove the options generateApis and apisToGenerate. All the available functionality is accessible by setting globalProperties.apis accordingly.


The same probably also applies to globalProperties.models and globalProperties.supportingFiles.

If this proposal is accepted by a maintainer, I'd be open to work on a PR.

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 by reviewing the openapi-generator-maven-plugin handling for generateApis and apisToGenerate, then inspect the related tests and plugin documentation. Confirm how globalProperties.apis currently provides the same functionality and define done as removing the two options without losing supported API-selection behavior; the possible models and supportingFiles changes need maintainer confirmation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 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.