OpenAPITools / OpenAPITools/openapi-generator

[REQ] Document configuration file reference format

Open
#18,043 0 comments 2 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.

We are using the maven plugin of the generator, however we feel like yaml is easier to read and modify compared to the pom.xml, so we want to make use of the config file you can pass to the generator. However I'm not able to find a full reference for the configuration file - I know some of the options depend on the generator, but stuff like templateDir or verbose should also be documented somewhere. Also in doc sections like these, there is a files key shown, but I can't find any documentation on the available options.

Describe the solution you'd like

I want a page in the docs that lists all available (global) config options for the config file, that are not covered by openapi-generator-cli config-help -g <generator>.

Describe alternatives you've considered

None

Additional context

None

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 configuration-file documentation and the customization page's user-defined templates example, then compare them with the options exposed by openapi-generator-cli config-help -g <generator> and the Maven plugin. Done means a documentation page lists all global config-file options not covered by generator-specific help, including options such as templateDir, verbose, and the files key.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, yaml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.