Describe and support non-numeric floats #828
Merged
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
Smithy floats and doubles are defined by IEEE754, which includes support for a few non-numeric values. This adds information to the AWS protocols docs on how to serialize them.
JordonPhillips
requested review from
kstich,
mtdowling and
srchase
as code owners
This adds support for non-numeric float values in jsonschema and openapi. It is disabled by default because it makes the type signature awful, and enabling it by default would be a backwards incompatible change.
JordonPhillips
force-pushed
the
infinity-node
branch
from
89d11be
to
91792a7
Compare
mtdowling
requested changes
Jun 11, 2021
| @@ -106,6 +106,22 @@ | |||
| return builder; | |||
| } | |||
|
|
|||
| private void updateFloatFormat(Schema.Builder builder, JsonSchemaConfig config, String format) { | |||
There was a problem hiding this comment.
This is a bit unfortunate. I wonder if later we can rethink the divide between OpenAPI and JSON Schema converters.
.../src/main/java/software/amazon/smithy/model/validation/node/NonNumericFloatValuesPlugin.java
Show resolved
Hide resolved
kstich
requested changes
Jun 11, 2021
JordonPhillips
requested review from
mtdowling and
kstich
and removed request for
srchase
This was referenced Jun 15, 2021
mtdowling
approved these changes
Jun 15, 2021
mtdowling
approved these changes
Jun 16, 2021
kstich
approved these changes
Jun 16, 2021
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.
This documents how the non-numeric floating point values
NaN,Infinity, and-Infinityare handled in protocols. Essentially they are serialized as the protocol's strings with those values. Protocol tests have been added to each AWS protocol to assert that behavior.Since JSON explicitly disallows these values, the jsonschema tooling doesn't enable them by default. This was also done because defaulting that behavior would be a breaking change.
Fixes #812
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.