Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #2442
Closed
Open
Issue created Mar 19, 2019 by Administrator@rootContributor

[REQ] Provide support to config-help to output sample yaml config file

Created by: dragosnutu

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

It would be great to have support to generate config.yml file with default values and documentation about available options for each language.

Together with this https://github.com/OpenAPITools/openapi-generator/issues/2425 we could than easily have a template config file.

Describe the solution you'd like

When using config-help cli option we now have --format two options. text and markdown. We could have a third option like yamlsample that will basically will generate yaml like format to output. Also in combination with --output there will be the possibility to save it and the modify it according.

Describe alternatives you've considered

The alternative is to read documentation and manually add documentation and values to a yaml file.

Additional context

This would easily help users to see/change available options, and also if any other options might appear or the documentation will change they can regenerate the configurations, see the differences and adjust the config easily (using git diff, or any other diff tool).

Assignee
Assign to
Time tracking