Fix OpenAPI error examples missing when service-level and operation-level errors share HTTP status codes #2754
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
justincange
force-pushed
the
jc/error-bug
branch
from
71cb7a7 to
f0fda09
Compare
justincange
force-pushed
the
jc/error-bug
branch
from
f0fda09 to
3f376e0
Compare
haydenbaker
suggested changes
Sep 10, 2025
.../src/main/java/software/amazon/smithy/openapi/fromsmithy/protocols/AbstractRestProtocol.java
Show resolved
Hide resolved
...i/src/test/java/software/amazon/smithy/openapi/fromsmithy/ServiceLevelErrorOverrideTest.java
Outdated
Show resolved
Hide resolved
haydenbaker
reviewed
Sep 11, 2025
.../src/test/java/software/amazon/smithy/openapi/fromsmithy/ErrorDeconflictingExamplesTest.java
Outdated
Show resolved
Hide resolved
haydenbaker
reviewed
Sep 11, 2025
.../src/test/java/software/amazon/smithy/openapi/fromsmithy/ErrorDeconflictingExamplesTest.java
Outdated
Show resolved
Hide resolved
haydenbaker
reviewed
Sep 11, 2025
Comment on lines
108
to
132
| // The bug: When ValidationException (service-level) and CustomError (operation-level) | ||
| // both map to 400, the service-level error takes precedence and operation-specific | ||
| // examples are lost | ||
| assertTrue(jsonContent.getMember("examples").isPresent(), | ||
| "BUG: Service-level ValidationException overrides operation-specific CustomError examples. " + | ||
| "Expected CustomError examples to appear in 400 response but they are missing."); | ||
|
|
||
| ObjectNode examples = jsonContent.expectMember("examples").expectObjectNode(); | ||
| assertFalse(examples.getMembers().isEmpty(), | ||
| "Expected CustomError examples in 400 response content"); | ||
|
|
||
| // Look for our specific custom error example content | ||
| boolean foundCustomErrorExample = examples.getMembers().values().stream() | ||
| .filter(Node::isObjectNode) | ||
| .map(node -> node.expectObjectNode()) | ||
| .filter(example -> example.getMember("value").isPresent()) | ||
| .map(example -> example.expectMember("value").expectObjectNode()) | ||
| .anyMatch(value -> | ||
| value.getMember("code").filter(node -> "CUSTOM_ERROR".equals(node.expectStringNode().getValue())).isPresent() && | ||
| value.getMember("message").filter(node -> "Custom error occurred".equals(node.expectStringNode().getValue())).isPresent() | ||
| ); | ||
|
|
||
| assertTrue(foundCustomErrorExample, | ||
| "Expected to find CustomError example with code 'CUSTOM_ERROR' and message 'Custom error occurred' " + | ||
| "but service-level ValidationException appears to be overriding it"); |
There was a problem hiding this comment.
Instead of doing all of this manual assertion, let's just have the expected generated openapi file as a test resource and assert that it matches. Check AwsRestJson1ProtocolTest to see how that's done.
There was a problem hiding this comment.
Done, tried to do it in a more focused, concise way just for this use case
haydenbaker
reviewed
Sep 11, 2025
.../src/test/java/software/amazon/smithy/openapi/fromsmithy/ErrorDeconflictingExamplesTest.java
Outdated
Show resolved
Hide resolved
haydenbaker
reviewed
Sep 11, 2025
.../src/test/java/software/amazon/smithy/openapi/fromsmithy/ErrorDeconflictingExamplesTest.java
Outdated
Show resolved
Hide resolved
haydenbaker
approved these changes
Sep 11, 2025
milesziemer
reviewed
Sep 12, 2025
.../src/test/java/software/amazon/smithy/openapi/fromsmithy/ErrorDeconflictingExamplesTest.java
Outdated
Show resolved
Hide resolved
milesziemer
approved these changes
Sep 12, 2025
…omsmithy/ErrorDeconflictingExamplesTest.java Co-authored-by: Miles Ziemer <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We noticed that when a Smithy service defines both service-level errors and operation-specific errors that map to the same HTTP status code, the generated OpenAPI spec includes the correct schema structure but completely omits error response examples.
Expected:
ErrorExamples from operation @examples should appear in HTTP error response sections.
Actual: Error response examples are missing while request and success examples work correctly.
This affects API documentation quality for services using both service-level and operation-specific errors.
This PR has the test case and a potential fix. Thanks!