Show media type example changes in reports - #930
Open
MoChiUaena wants to merge 3 commits into
Open
MoChiUaena wants to merge 3 commits into
MoChiUaena wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
All reported issues were addressed across 7 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
There was a problem hiding this comment.
All reported issues were addressed across 2 files (changes from recent commits).
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
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
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.
An
exampleorexamplesupdate can mark an operation as changed while leaving the report with no details when the schema stays the same.Add example details to the Console, Markdown, Asciidoc and HTML renderers. Added and removed values are shown directly; updates show the old and new values. For named
examples, the complete old and new maps are displayed. HTML values are escaped, and Markdown and Asciidoc values use code blocks. When Jackson reports a serialization error, that detail shows a placeholder and the rest of the report continues. A warning is logged without calling the example object'stoString(). Example changes keep their existing metadata classification.The 91 regression cases cover request and response examples, additions, removals, updates, examples alongside schema changes, unchanged examples, markup escaping, throwing getters, self-references, and serialization failures on either side of an update for both singular and named examples. All pass with this change.
Tested on Windows:
./mvnw.cmd -V -B -ntp -ff clean verifyon JDK 8, 11 and 21../mvnw.cmd -V -B -ntp -ff -Dmaven.compiler.release=8 clean verifyon JDK 17../mvnw.cmd -B -ntp com.coveo:fmt-maven-plugin:check.--statereturnsmetadata, and--fail-on-incompatibleexits 0.Fixes #872.
Summary by cubic
Media type example changes now show up in Console, Markdown, Asciidoc, and HTML reports, so an operation isn't marked changed with no visible detail when only an example value differs.
examplesdisplay as complete old and new maps.Written for commit 9e41545. Summary will update on new commits.