From ae49717a7fd391961884bd726599b9e79aac4794 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Fri, 15 Mar 2024 08:18:49 -0700 Subject: [PATCH] Add deprecation message in shape docs (#1209) --- .../amazon/smithy/typescript/codegen/TypeScriptWriter.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java index 0ccd7b7b448..0b37c181b40 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java @@ -190,7 +190,11 @@ boolean writeShapeDocs(Shape shape, UnaryOperator preprocessor) { .replace("}", "\\}"); docs = preprocessor.apply(docs); if (shape.getTrait(DeprecatedTrait.class).isPresent()) { - docs = "@deprecated\n\n" + docs; + DeprecatedTrait deprecatedTrait = shape.getTrait(DeprecatedTrait.class).get(); + String deprecationMessage = deprecatedTrait.getMessage().orElse(""); + String deprecationString = "@deprecated" + + (deprecationMessage.isEmpty() ? "" : " " + deprecationMessage); + docs = deprecationString + "\n\n" + docs; } docs = addReleaseTag(shape, docs); writeDocs(docs);