Skip to content

Improve missing field description validation #1052

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

Open
DavJaveiro wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve missing field description validation #1052

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
4 changes: 2 additions & 2 deletions ...stdocs-core/src/main/java/org/springframework/restdocs/payload/AbstractFieldsSnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ protected AbstractFieldsSnippet(String name, String type, List<FieldDescriptor>
for (FieldDescriptor descriptor : descriptors) {
Assert.notNull(descriptor.getPath(), "Field descriptors must have a path");
if (!descriptor.isIgnored()) {
Assert.notNull(descriptor.getDescription() != null, "The descriptor for '" + descriptor.getPath()
+ "' must have a" + " description or it must be marked as ignored");
Assert.notNull(descriptor.getDescription(), "The descriptor for '" + descriptor.getPath()
+ "' must have a description or it must be marked as ignored");
}
}
this.fieldDescriptors = descriptors;
Expand Down
9 changes: 9 additions & 0 deletions ...s-core/src/test/java/org/springframework/restdocs/payload/ResponseFieldsSnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,15 @@ void typeDeterminationDoesNotSetTypeOnDescriptor(OperationBuilder operationBuild
.isTable((table) -> table.withHeader("Path", "Type", "Description").row("`id`", "`Number`", "one"));
}

@SnippetTest
void undocumentedResponseFieldDescriptorMustHaveADescription() {
assertThatExceptionOfType(IllegalArgumentException.class)
.isThrownBy(() -> new ResponseFieldsSnippet(
Arrays.asList(fieldWithPath("input_data_type").type(JsonFieldType.STRING))))
.withMessage(
"The descriptor for 'input_data_type' must have a description or it must be marked as ignored");
}

@SnippetTest
void attemptToDocumentFieldsWithNoResponseBody(OperationBuilder operationBuilder) {
assertThatExceptionOfType(SnippetException.class)
Expand Down