Skip to content

Require @required trait on payloads #101

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

Merged
kubukoz merged 2 commits into from
Apr 18, 2026
Merged

Require @required trait on payloads #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c42260
Require `@required` trait on payloads
kubukoz Apr 11, 2026
c597b3f
Add @required to members using @jsonRpcPayload in tests
Copilot Apr 12, 2026
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: 4 additions & 0 deletions modules/smithy-tests/src/test/scala/jsonrpclib/JsonPayloadValidatorSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,20 @@ object JsonPayloadValidatorSpec extends FunSuite {
|}
|
|structure OpInput {
| @required
| @jsonRpcPayload
| data: String
|}
|
|structure OpOutput {
| @required
| @jsonRpcPayload
| data: String
|}
|
|@error("client")
|structure OpError {
| @required
| @jsonRpcPayload
| data: String
|}
Expand Down Expand Up @@ -76,6 +79,7 @@ object JsonPayloadValidatorSpec extends FunSuite {
|}
|
|structure NestedStructure {
| @required
| @jsonRpcPayload
| data: String
|}
Expand Down
8 changes: 4 additions & 4 deletions modules/smithy/src/main/resources/META-INF/smithy/jsonrpclib.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ string jsonRpcNotification

/// Binds a single structure member to the payload of a jsonrpc message.
/// Just like @httpPayload, but for jsonRpc.
@trait(selector: "structure > member", structurallyExclusive: "member")
@trait(selector: "structure > member[trait|required]", structurallyExclusive: "member")
@traitValidators({
"jsonRpcPayload.OnlyTopLevel": {
message: "jsonRpcPayload can only be used on the top level of an operation input/output/error.",
severity: "ERROR",
"jsonRpcPayload.OnlyTopLevel": {
message: "jsonRpcPayload can only be used on the top level of an operation input/output/error.",
severity: "ERROR",
selector: "$allowedShapes(:root(operation -[input, output, error]-> structure > member)) :not(:in(${allowedShapes}))"
}
})
Expand Down
Loading