docs: FAQ for additionalProperties error messages #479
Conversation
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
Also add ajv-errors to the list of related packages.
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.
Also add ajv-errors to the list of related packages.
What issue does this pull request resolve?
Apparently putting the property name in the additionalProperties error message has been requested multiple times. Perhaps it should be a FAQ?
What changes did you make?
Added your words from the PR with very minor tweaks to the FAQ. That seemed to be the best place, unless error messages should get their own section instead of going in the error API section.
Also linked ajv-errors in the README as I had not realized it existed (although maybe it's omitted for being too new? Happy to remove this if it's not wanted but the FAQ is)
Is there anything that requires more attention while reviewing?
Nope.