Generate correct "type" for Integer fields #118
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
Using a "type" of "number" and a "format" of "integer" is not documented in the JSON schema specification as a correct way to represent integers. Instead, a "type" of "integer" should be used as this ensure that validators will correctly validate inputs as an integer and not accept "number" values. https://json-schema.org/understanding-json-schema/reference/numeric.html?highlight=integer#integer Signed-off-by: Ben Steadman <[email protected]>
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.
Closes #117
Using a
typeofnumberand aformatofintegeris not documented in the JSON schema specification as a correct way to represent integers. Instead, atypeofintegershould be used as this ensure that validators will correctly validate inputs as an integer and not acceptnumbervalues.This is a breaking change as there is potential for previous successful validations to fail if users are validating
number(e.g. floats) values against integer fields.