Add support for validating different IDL versions #917
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
Various IDL features are only supported in versions > 1.0, including mixins, the "!" suffix for structure members, and other features soon to come. This commit adds version-specific validation to the IDL loading process to ensure that these features are only used in the appropriate versions. Given we're moving to Smithy IDL 2.0 instead of 1.1, I started using 2.0 in test cases. I'll send a followup commit that updates everything from 1.0 or 1.1 to 2.0. I kept that out of this commit to make it easier to review.
JordonPhillips
approved these changes
Sep 24, 2021
| if (!modelFile.getVersion().supportsRequiredSugar()) { | ||
| throw syntax(memberId, String.format( | ||
| "The '!' suffix can only be used on structure members when using Smithy 2.0 or later, but " | ||
| + "you're using version `%s`. Make `$version: \"2\"` the first line of this file.", |
There was a problem hiding this comment.
"Make `$version: "2"` the first line of this file to update" or something to indicate they're updating (pedantic i know but still)
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.
Various IDL features are only supported in versions > 1.0, including
mixins, the "!" suffix for structure members, and other features soon to
come. This commit adds version-specific validation to the IDL loading
process to ensure that these features are only used in the appropriate
versions.
Given we're moving to Smithy IDL 2.0 instead of 1.1, I started using 2.0
in test cases. I'll send a followup commit that updates everything from
1.0 or 1.1 to 2.0. I kept that out of this commit to make it easier to
review.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.