Skip to content

fix(docs): improve deprecatedTrait with default description #1541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
+38 −5
Open

fix(docs): improve deprecatedTrait with default description #1541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
47eefe3
fix(docs): improve deprecatedTrait with default description
aBurmeseDev Mar 4, 2025
59f11a2
fix: ensure deprecated annotations always include message for TSDoc c…
aBurmeseDev Sep 26, 2025
29c0c4d
chore: remove prefix spaces
aBurmeseDev Oct 6, 2025
b4e0d94
fix(util-body-length-node): restrict fs calls to fs.ReadStream object…
kuhe Oct 7, 2025
9d6ef6d
feat: use feature detection for defaults-mode-browser (#1730)
kuhe Oct 7, 2025
fb7bffd
refactoring to reduce code size (#1720)
kuhe Oct 8, 2025
17ed62c
Version NPM packages
aws-smithy-automation Oct 8, 2025
1c187ac
Run gradle publish step in CI (#1737)
trivikr Oct 8, 2025
a241daf
add SerdeContext base class (#1738)
kuhe Oct 9, 2025
824a48c
feat: generate static schema (#1739)
kuhe Oct 10, 2025
e9420ca
chore: de-namespace types (#1741)
kuhe Oct 10, 2025
03c54b9
improve memberDocs deprecatedTrait with fallback message
aBurmeseDev Oct 10, 2025
91a7a27
Merge branch 'smithy-lang:main' into john-docs
aBurmeseDev Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions private/my-local-model/src/commands/GetNumbersCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ export interface GetNumbersCommandOutput extends GetNumbersResponse, __MetadataB
* const input = { // GetNumbersRequest
* bigDecimal: Number("bigdecimal"),
* bigInteger: Number("bigint"),
* fieldWithoutMessage: "STRING_VALUE",
* fieldWithMessage: "STRING_VALUE",
* };
* const command = new GetNumbersCommand(input);
* const response = await client.send(command);
Expand Down
15 changes: 15 additions & 0 deletions private/my-local-model/src/models/models_0.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ export class CodedThrottlingError extends __BaseException {
export interface GetNumbersRequest {
bigDecimal?: NumericValue | undefined;
bigInteger?: bigint | undefined;
/**
* This is deprecated documentation annotation
*
* @deprecated see description
* @public
*/
fieldWithoutMessage?: string | undefined;

/**
* This is deprecated documentation annotation
*
* @deprecated This field has been deprecated
* @public
*/
fieldWithMessage?: string | undefined;
}

/**
Expand Down
2 changes: 2 additions & 0 deletions private/my-local-model/src/protocols/Rpcv2cbor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,8 @@ const se_GetNumbersRequest = (input: GetNumbersRequest, context: __SerdeContext)
return take(input, {
bigDecimal: __nv,
bigInteger: [],
fieldWithMessage: [],
fieldWithoutMessage: [],
});
};

Expand Down
15 changes: 10 additions & 5 deletions ...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,10 +225,9 @@ boolean writeShapeDocs(Shape shape, UnaryOperator<String> preprocessor) {
if (shape.getTrait(DeprecatedTrait.class).isPresent()) {
DeprecatedTrait deprecatedTrait = shape.expectTrait(DeprecatedTrait.class);
String deprecationMessage = deprecatedTrait.getMessage()
.map(msg -> " " + msg)
.orElse("");
String deprecationString = "@deprecated" + deprecationMessage;
docs = docs + "\n\n" + deprecationString;
.orElse("deprecated");
String deprecationAnnotation = "@deprecated " + deprecationMessage;
docs = docs + "\n\n" + deprecationAnnotation;
}
docs = preprocessor.apply(docs);
docs = addReleaseTag(shape, docs);
Expand Down Expand Up @@ -266,7 +265,13 @@ boolean writeMemberDocs(Model model, MemberShape member) {
docs = docs.replace("{", "\\{")
.replace("}", "\\}");
if (member.getTrait(DeprecatedTrait.class).isPresent() || isTargetDeprecated(model, member)) {
docs = docs + "\n\n@deprecated";
DeprecatedTrait deprecatedTrait = member.getTrait(DeprecatedTrait.class)
.or(() -> model.expectShape(member.getTarget()).getTrait(DeprecatedTrait.class))
.orElseThrow();
String deprecationMessage = deprecatedTrait.getMessage()
.orElse("deprecated");
String deprecationAnnotation = "@deprecated " + deprecationMessage;
docs = docs + "\n\n" + deprecationAnnotation;
}
docs = addReleaseTag(member, docs);
writeDocs(docs);
Expand Down
9 changes: 9 additions & 0 deletions smithy-typescript-protocol-test-codegen/model/my-local-model/main.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,16 @@ operation GetNumbers {
@input
structure GetNumbersRequest {
bigDecimal: BigDecimal

bigInteger: BigInteger

@documentation("This is deprecated documentation annotation")
@deprecated
fieldWithoutMessage: String

@documentation("This is deprecated documentation annotation")
@deprecated(message: "This field has been deprecated", since: "3.0")
fieldWithMessage: String
}

@output
Expand Down