Disable additional properties for majority of schemas in API #152
Conversation
This file contains 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
ghost
self-requested a review
as a 
FrimIdan
previously approved these changes
Mar 19, 2023
By disabling additional properties in the API it ensures that if someone sends a property that we don't understand the API server responds with a 400 error. This is particularly useful if you make a spelling mistake when crafting an API request because the mispelled field will result in an error instead of being accepted and ignored as an addtional property. The only schemas which can't have additionalProperties disabled are common schemas which are included in "allOf" statements, that add additional fields by combining schemas. Instead additionalProperties: false is added to the combined schema instead.
akpsgit
force-pushed
the
block_additional_properties
branch
from
ee12e3b
to
660d9a9
Compare
akpsgit
approved these changes
Mar 19, 2023
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.
Description
By disabling additional properties in the API it ensures that if someone sends a property that we don't understand the API server responds with a 400 error.
This is particularly useful if you make a spelling mistake when crafting an API request because the mispelled field will result in an error instead of being accepted and ignored as an addtional property.
The only schemas which can't have additionalProperties disabled are common schemas which are included in "allOf" statements, that add additional fields by combining schemas. Instead additionalProperties: false is added to the combined schema instead.
Type of Change
[X] Bug Fix
[ ] New Feature
[ ] Breaking Change
[ ] Refactor
[ ] Documentation
[ ] Other (please describe)
Checklist