Make adoption of Unit easier for existing models #1034
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
Considering Unit a neighbor of operations when it is the declared or implicit input or output means that any other shape named Unit in the service closure will be considered conflicting where it was not previously. By removing this relationship, existing models will continue to work without renames.
mtdowling
reviewed
Jan 6, 2022
| @@ -130,6 +135,11 @@ public boolean isInlined(Shape shape) { | |||
| return isInlined(target); | |||
| } | |||
|
|
|||
| // smithy.api#Unit is always inlined | |||
| if (UnitTypeTrait.UNIT.equals(shape.getId())) { | |||
There was a problem hiding this comment.
I think things like API Gateway will generate names for anonymous objects (which this code would cause). Is there a way to generate a Unit shape in the JSON Schema for tagged unions members, but not for operation input?
There was a problem hiding this comment.
I have hacked this PR to do this, but the implementation via a boolean flag screams "this is not the right way to accomplish this."
This would be so much easier if we had service attached shapes; then I could meaningfully use relationship data to examine what's actually attached to the scope of the conversion, and a lot of this code would be a lot simpler.
adamthom-amzn
force-pushed
the
remove-unit-edge
branch
2 times, most recently
from
4058704 to
96e288d
Compare
mtdowling
reviewed
Jan 6, 2022
smithy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/DeconflictingStrategy.java
Outdated
Show resolved
Hide resolved
mtdowling
approved these changes
Jan 6, 2022
By always inlining Unit as an empty object rather than creating a pointer to a Unit schema, models will not need to rename either the built-in Unit or Units of their own in order to perform JSONSchema conversion.
adamthom-amzn
force-pushed
the
remove-unit-edge
branch
from
96e288d to
ec7913b
Compare
mtdowling
approved these changes
Jan 6, 2022
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 of changes:
Prevents Unit from being added to the service closure if it is only used by operation inputs and/or outputs, and
special-cases Unit for both operations and unions in JSONSchema conversion.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.