Skip to content

Missing required field goes unreported when its path shares a prefix with an absent optional field #1057

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
wilkinsona merged 1 commit into from
Sep 30, 2026
Merged

Missing required field goes unreported when its path shares a prefix with an absent optional field #1057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion ...-restdocs-core/src/main/java/org/springframework/restdocs/payload/JsonContentHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,18 @@ private boolean isNestedBeneathMissingOptionalField(FieldDescriptor descriptor,
List<FieldDescriptor> candidates = new ArrayList<>(this.fieldDescriptors);
candidates.remove(descriptor);
for (FieldDescriptor candidate : candidates) {
if (candidate.isOptional() && descriptor.getPath().startsWith(candidate.getPath())
if (candidate.isOptional() && isNestedBeneath(candidate.getPath(), descriptor.getPath())
&& isMissing(candidate, payload)) {
return true;
}
}
return false;
}

private boolean isNestedBeneath(String ancestorPath, String path) {
return path.equals(ancestorPath) || path.startsWith(ancestorPath + ".") || path.startsWith(ancestorPath + "[");
}

private boolean isMissing(FieldDescriptor candidate, Object payload) {
if (!this.fieldProcessor.hasField(candidate.getPath(), payload)) {
return true;
Expand Down
20 changes: 20 additions & 0 deletions ...docs-core/src/test/java/org/springframework/restdocs/payload/JsonContentHandlerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,26 @@ void describedFieldThatIsNotPresentNestedBeneathOptionalFieldThatIsNotPresentIsN
assertThat(missingFields.size()).isEqualTo(0);
}

@Test
void describedFieldThatIsNotPresentWithPathPrefixedByPathOfMissingOptionalFieldIsConsideredMissing() {
List<FieldDescriptor> descriptors = Arrays.asList(new FieldDescriptor("a").optional(),
new FieldDescriptor("ab"));
List<FieldDescriptor> missingFields = new JsonContentHandler("{\"c\":\"charlie\"}".getBytes(), descriptors)
.findMissingFields();
assertThat(missingFields.size()).isEqualTo(1);
assertThat(missingFields.get(0).getPath()).isEqualTo("ab");
}

@Test
void describedNestedFieldThatIsNotPresentWithPathPrefixedByPathOfMissingOptionalFieldIsConsideredMissing() {
List<FieldDescriptor> descriptors = Arrays.asList(new FieldDescriptor("a.b").optional(),
new FieldDescriptor("a.bc"));
List<FieldDescriptor> missingFields = new JsonContentHandler("{\"a\":{}}".getBytes(), descriptors)
.findMissingFields();
assertThat(missingFields.size()).isEqualTo(1);
assertThat(missingFields.get(0).getPath()).isEqualTo("a.bc");
}

@Test
void describedFieldThatIsNotPresentNestedBeneathOptionalArrayThatIsEmptyIsNotConsideredMissing() {
List<FieldDescriptor> descriptors = Arrays.asList(new FieldDescriptor("outer"),
Expand Down
Loading