Wrap refs with defaults in an allOf #1887
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
|
Can you test this to make sure it works with APIGW? |
mtdowling
reviewed
Jul 28, 2023
| }, | ||
| { | ||
| "default": "FOO" | ||
| } |
There was a problem hiding this comment.
I guess this is a better way to do member documentation traits too
Updated the issue description with API Gateway testing. |
srchase
force-pushed
the
defaults-on-refs
branch
2 times, most recently
from
73a5408 to
91450b7
Compare
mtdowling
requested changes
Jul 31, 2023
srchase
force-pushed
the
defaults-on-refs
branch
from
91450b7 to
36f1754
Compare
mtdowling
approved these changes
Jul 31, 2023
syall
pushed a commit
to Xtansia/smithy
that referenced
this pull request
Aug 11, 2023
alextwoods
pushed a commit
to alextwoods/smithy
that referenced
this pull request
Sep 15, 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.
Fixes #1844.
According to both the 3.1.0 spec, and the 3.0.2 spec, additional fields on
referenceObjectsare ignored.This PR adds a JsonSchema configuration option,
disableDefaultValues. JsonSchemaShapeVisitor is updated to wrap any members with a@defaulttrait applied which target a$refwith anallOfso that the default can be handled correctly by OpenAPI when this configuration option is enabled.While JsonSchema's configuration will use this setting by default, it is disabled by default for API Gateway. API Gateway does not support default values anyways, so disabling this option will make
$refand top-level definitions consistent by not using defaults in either form.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.