OpenAPITools / OpenAPITools/openapi-generator

[REQ] Configuration options are somewhat confusing

Open
#8,824 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

Within the maven plugin configuration you have the potential to have something like this:

<configuration>
   <property1>blah</prope
    <configurationFile>my-config-file-containing-other-properties.json</configurationFile>
    <configOptions>
         <moreProperties>blah blah</moreProperties>
    </configOptions> 
    <additionalProperties>
          <evenMoreProperties>blah blah blah</evenMoreProperties>
    </additionalProperties>
</configuration>

The configurationFile mentions "Path to separate json configuration file" but what options go in this file?
Does the config file override the all the properties? Which has presidence?

This is so confusing! Can we have a clear definition of what the config options/properties should be either in a single file or structure rather than options upon properties upon config files

Either improve the structure or have better naming. Maybe include more examples in the documentation as Ive seen all sorts of different variations

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 with the Maven plugin configuration entry point and the documented configurationFile, configOptions, and additionalProperties options. Review existing examples to determine the accepted JSON contents and precedence rules. Done means the configuration model is simplified or the documentation clearly defines valid options, naming, precedence, and representative examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, json
Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.