Use @deprecated info when building OpenAPI description
#2222
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
kstich
requested changes
Apr 11, 2024
smithy-model/src/main/java/software/amazon/smithy/model/traits/DeprecatedTrait.java
Outdated
Show resolved
Hide resolved
smithy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/JsonSchemaShapeVisitor.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Kevin Stich <kevin@kstich.com>
Co-authored-by: Kevin Stich <kevin@kstich.com>
kstich
approved these changes
Apr 11, 2024
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.
Background
The objective is to add
@deprecatedto the description of the definition in OpenAPI.Let me know if this makes sense or if the way the description is built makes sense.
Testing
Added a couple of tests.