Skip to content
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

Expand usage of title trait #2461

Merged
merged 2 commits into from
Nov 13, 2024
Merged

Expand usage of title trait #2461

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e50998
Expand usage of title trait
hpmellema Nov 13, 2024
ae56924
Add test for jsonschema behavior
hpmellema Nov 13, 2024
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
4 changes: 2 additions & 2 deletions 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 @@ -388,9 +388,9 @@ 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
used in automatically generated documentation and other contexts to
provide a user friendly name for services and resources.
provide a user friendly name for a shape.
Trait selector
``:is(service, resource)``
``:not(member)``

*Any service or resource*
Value type
Expand Down
5 changes: 2 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 @@ -668,9 +668,8 @@ list tags {
/// Defines a proper name for a service or resource shape.
///
/// This title can be used in automatically generated documentation
/// and other contexts to provide a user friendly name for services
/// and resources.
@trait(selector: ":is(service, resource)")
/// and other contexts to provide a user friendly for shapes.
@trait(selector: ":not(member)")
string title

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