Basic support of @deprecated trait in Smithy model #1570
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
weihanglo
force-pushed
the
weihanglo-issue-356
branch
2 times, most recently
from
c6540f0
to
1ea10f8
Compare
This comment was marked as outdated.
This comment was marked as outdated.
|
We should warn, not error out, on deprecated |
Reasonable to me. However, |
We are on 1.58 and we always remain behind in terms of Rust versions. Let's allow it and add a note to remove it when possible |
crisidev
suggested changes
Jul 26, 2022
codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/RustTypes.kt
Outdated
Show resolved
Hide resolved
codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/RustTypes.kt
Outdated
Show resolved
Hide resolved
...ware/amazon/smithy/rust/codegen/server/smithy/generators/ServerCombinedErrorGeneratorTest.kt
Outdated
Show resolved
Hide resolved
codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/RustWriter.kt
Outdated
Show resolved
Hide resolved
weihanglo
force-pushed
the
weihanglo-issue-356
branch
2 times, most recently
from
3cdd51c
to
4061a1c
Compare
weihanglo
force-pushed
the
weihanglo-issue-356
branch
from
4061a1c
to
beca03b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
crisidev
suggested changes
Jul 26, 2022
codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/RustTypes.kt
Outdated
Show resolved
Hide resolved
This comment was marked as outdated.
This comment was marked as outdated.
* `Attribute.Custom.deprecated` is the main logic for building up `#[deprecated]` attribute * `RustWriter.deprecatedShape` is the counterpart of `documentShape`, but we do not going to generalize it as what `documentShape` does. Deprecated is only for Rust code and probably won't be used in other output language. Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
Signed-off-by: Weihang Lo <[email protected]>
weihanglo
force-pushed
the
weihanglo-issue-356
branch
from
e78a7f1
to
3006aac
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Velfi
approved these changes
Jul 26, 2022
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
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.
Motivation and Context
#356
Basic support of [@deprecated] trait in Smithy model.
Description
Same feature parity between Smithy and Rust
The feature parity of
@deprecatedtrait in Smithy model is exact the same as#[deprecated]attribute in Rust. Both have a since field to indicate when it has been deprecated, with an additional note/message field.Service shapes are not supported
This patch mostly takes the implementation of documentation trait as a reference. Everywhere
documentShapebeing called would get its counterpart ofdeprecatedShape, which is in exact our implementation of generating#[deprecated]attribute from@deprecatedtrait.As a result, some important shapes haven't yet got support with documentation trait are also not going to get
@deprecatedfeature. Namely, service, resource, and operation trait are not supported.Support
deprecatedproperty in@enumtraitThe other feature that is not actually a
@deprecatedtrait but would start generating#[deprecated]attribute is@enumtrait, which has an optionaldeprecatedproperty is the same as deprecated trait in terms of functionality. This part resides in EnumGenerator.kt.Testing
The simplest test is play around with
@deprecatedtrait with different models.