swisnl / openapi-spec-generator

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

Add configuration options for Server Info section #13

Open MarcEspiard opened 1 year ago

MarcEspiard commented 1 year ago

Description

Added the ability to configure additional entries of the Info section:

Motivation and context

It wasn't possible to do so before this PR and was in the TODO list. We need it for our current project

How has this been tested?

Generation has been tested with and without the changes enabled, all works as intended. This is a very simple change.

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!

MarcEspiard commented 1 year ago

No problem, all done :)

JaZo commented 1 year ago

The only concern I have is that, when we merge this, all existing users will have the example.com URLs in their documentation. I think we should leave the defaults empty for now. Maybe just comment them out or something like that?