Modifies ExamplesTraitValidator to handle cases where both output and error are defined #1599
Conversation
This commit changes the behavior of the ExamplesTraitValidator when both output and error are defined. This is achieved by treating the output member as optional, only validating it if it's present and failing when it's defined alongside the error member.
| boolean isOutputDefined = example.getOutput().isPresent(); | ||
| boolean isErrorDefined = example.getError().isPresent(); | ||
|
|
||
| if (isOutputDefined && isErrorDefined) { |
There was a problem hiding this comment.
If this is the behaviour we want, this needs to be mentioned in the doc as well.
https://smithy.io/2.0/spec/documentation-traits.html?highlight=example#examples-trait
| } else { | ||
| if (isErrorDefined) { |
There was a problem hiding this comment.
nit: the if statements for isErrorDefined and isOutputDefined can be moved into the outer layer as else if statements.
| @@ -133,8 +133,8 @@ public ObjectNode getInput() { | |||
| /** | |||
| * @return Gets the output object. | |||
| */ | |||
| public ObjectNode getOutput() { | |||
| return output; | |||
| public Optional<ObjectNode> getOutput() { | |||
There was a problem hiding this comment.
A bit of a breaking change... but maybe using this trait in code is fringe enough to not matter
There was a problem hiding this comment.
I thought about keeping it as is and checking if example.getOutput().isEmpty() to check if it was defined, but it opened the possibility of the example below being valid, which I think shouldn't be, if it's present it should conform, even if empty:
$version: "2.0"
namespace example.hello
@examples([
{
title: "Unhappy path",
output: {},
error: {
shapeId: YouShallNotPass
content: {
"message": "Go back to the Shadow"
}
}
}
])
operation Hello {
output: Greeting,
errors: [YouShallNotPass]
}
structure Greeting {
@required
message: String
}
@error("client")
structure YouShallNotPass {
@required
message: String
}
Issue #, if available:
#1582
Description of changes:
This change modifies the behavior of the ExamplesTraitValidator when
both output and error are defined. This is achieved by treating the
output member as optional, only validating it if it's present and
failing when it's defined alongside the error member.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.