Improve missing field description validation - #1052
Open
DavJaveiro wants to merge 1 commit into
Open
Conversation
Signed-off-by: DavJaveiro <davidson.linhares@outlook.com>
DavJaveiro
force-pushed
the
gh-678-missing-field-description
branch
from
August 1, 2026 17:56
6ed8975 to
8c8530e
Compare
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
2 participants
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.
This updates field descriptor validation to check the descriptor's description directly
rather than the result of comparing it with null.
Previously, a field descriptor without a description was not rejected during snippet
construction because
descriptor.getDescription() != nullproduced a non-null Booleanvalue. This allowed the missing description to be reported later as a template rendering
error.
A regression test has been added to verify that a non-ignored field descriptor without a
description fails with a clear message.
Closes #678
Tests:
./gradlew :spring-restdocs-core:test./gradlew check