Skip to content
GitLab

Implement yamlsample config help output

Merged Administrator requested to merge github/fork/dragosnutu/feature/yaml-sample-cfg-help into master

Created by: dragosnutu

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

Added another option for the config-help --format called yamlsample that will basically outputs key value pairs with default values. Also comments with the description of the cli option. If the value doesn't have default value it is commented out and the user has the possibility to uncomment and set a value.

Ref: #2442 (closed)