Produce better warnings when using configuration options that have been removed#90
Merged
liamnichols merged 1 commit intomainCreateAPI/CreateAPI:mainfrom Aug 4, 2022
Merged
Produce better warnings when using configuration options that have been removed#90liamnichols merged 1 commit intomainCreateAPI/CreateAPI:mainfrom
liamnichols merged 1 commit intomainCreateAPI/CreateAPI:mainfrom
Conversation
…e no longer supported
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
1 participant
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.
In #77 we started emitting warnings for unknown properties that were found in the config options as well as deprecations:
While the deprecations are useful, to begin with we are going to be a bit more aggressive and skip deprecating types meaning that when upgrading from 0.0.5 to 0.1.0, you'll end up seeing warnings like "Found an unexpected property 'overridenResponses' (in 'paths')."
This might initially be confusing to the user since it use to work. The aim of this change is to tweak the messaging to better support direct replacements without deprecation.
With this change, a user defining
overridenResponsesin the config will now see the following:Its mostly similar to the deprecation besides one thing: it doesn't assume the property was only renamed (i.e the behaviour could change). Its just a small helper to improve the developer experience.