feat: add contact and license to GenerateOpenApiDocumentOptions#157
Open
liorp wants to merge 1 commit into
Open
feat: add contact and license to GenerateOpenApiDocumentOptions#157liorp wants to merge 1 commit into
liorp wants to merge 1 commit into
Conversation
Extends the info block options to include optional `contact` and `license` fields, mapping 1:1 to the OpenAPI 3.x InfoObject sub-objects. Eliminates the need for post-mutation workarounds to satisfy linters (e.g. Redocly's info-contact rule). Closes mcampa#156
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #156.
Extends
GenerateOpenApiDocumentOptionswith optionalcontactandlicensefields that map 1:1 to the OpenAPI 3.xinfosub-objects:Changes
OpenApiContactObjectandOpenApiLicenseObjectinterfaces (exported)contact?andlicense?fields toGenerateOpenApiDocumentOptionsinfoblock ingenerateOpenApiDocumentwhen providedWhy
Redocly and other OpenAPI linters warn when
info.contactis absent (info-contactrule). Previously the only workaround was post-mutating the returned document, which pushes metadata that naturally belongs in the options object into imperative code.