Skip to content

feat: Expand @title to members, and map the title for oneOf variants #2791

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 1 commit into
base: main
Choose a base branch
from
Open

feat: Expand @title to members, and map the title for oneOf variants #2791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion docs/source-2.0/spec/documentation-traits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ tags trait are arbitrary and up to the model author.
===============

Summary
Defines a proper name for a service or resource shape. This title can be
Defines a proper name for a shape. This title can be
used in automatically generated documentation and other contexts to
provide a user friendly name for a shape.
Trait selector
Expand Down
4 changes: 4 additions & 0 deletions ...hy-jsonschema/src/main/java/software/amazon/smithy/jsonschema/JsonSchemaShapeVisitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,9 +267,13 @@ public Schema enumShape(EnumShape shape) {
MemberShape member = entry.getValue();
Schema enumSchema = Schema.builder()
.constValue(StringNode.from(enumValues.get(memberName)))
.title(member.getTrait(TitleTrait.class)
.map(TitleTrait::getValue)
.orElse(null))
.description(member.getTrait(DocumentationTrait.class)
.map(DocumentationTrait::getValue)
.orElse(null))

.build();

schemas.add(enumSchema);
Expand Down
3 changes: 2 additions & 1 deletion .../test/resources/software/amazon/smithy/jsonschema/string-enums-one-of.jsonschema.v07.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"description": "it really does foo"
},
{
"const": "Bar"
"const": "Bar",
"title": "TestEnum Bar"
}
]
}
Expand Down
1 change: 1 addition & 0 deletions smithy-jsonschema/src/test/resources/software/amazon/smithy/jsonschema/string-enums.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ structure Foo {
enum TestEnum {
@documentation("it really does foo")
FOO = "Foo"
@title("TestEnum Bar")
BAR = "Bar"
}
6 changes: 3 additions & 3 deletions smithy-model/src/main/resources/software/amazon/smithy/model/loader/prelude.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,11 +666,11 @@ list tags {
member: String
}

/// Defines a proper name for a service or resource shape.
/// Defines a proper name for a shape.
///
/// This title can be used in automatically generated documentation
/// and other contexts to provide a user friendly for shapes.
@trait(selector: ":not(member)")
/// and other contexts to provide a user-friendly for shapes.
@trait
string title

/// Constrains the acceptable values of a string to a fixed set
Expand Down
Loading