swisnl / openapi-spec-generator

Creates Open API spec for a Laravel JSON:API
Apache License 2.0
23 stars 11 forks source link

Allow configuration of YAML output format through config #14

Open MarcEspiard opened 1 year ago

MarcEspiard commented 1 year ago

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:

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.

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