openapi-spec-generator icon indicating copy to clipboard operation
openapi-spec-generator copied to clipboard

Allow configuration of YAML output format through config

Open MarcEspiard opened this issue 1 year ago • 0 comments

Description

Adds an option to control the inline and indent of the yaml output through config

Motivation and context

Useful for readability of exported yaml file, especially during development of the api when you might not have a solution yet to display the docs in an actual frontend. It is also coherent with the json output format using the JSON_PRETTY_PRINT flag, this PR allows you to pretty print the YAML file if you wish to do so. It is backward compatible with default values not changing behavior for existing installs

How has this been tested?

Tested the output while changing config values, all works as expected

Screenshots (if appropriate)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.

  • [x] I have read the CONTRIBUTING document.
  • [x] My pull request addresses exactly one patch/feature.
  • [x] I have created a branch for this patch/feature.
  • [x] Each individual commit in the pull request is meaningful.
  • [x] I have added tests to cover my changes.
  • [x] If my change requires a change to the documentation, I have updated it accordingly.

If you're unsure about any of these, don't hesitate to ask. We're here to help!

MarcEspiard avatar Jun 08 '23 21:06 MarcEspiard