Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Propagate ignoreUndocumentedParamteres with .and()

Browse Source 
See gh-676
This commit is contained in:
Brice Dutheil
2020-03-30 18:24:18 +02:00
committed by Andy Wilkinson
parent b02fcbee6a
commit eac7d67c4e
3 changed files with 14 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
spring-restdocs-core/src/main/java/org/springframework/restdocs/request/AbstractParametersSnippet.java
View File

@@ -148,6 +148,10 @@ public abstract class AbstractParametersSnippet extends TemplatedSnippet {
return this.descriptorsByName;
}
protected final boolean isIgnoreUndocumentedParameters() {
return ignoreUndocumentedParameters;
}
/**
* Returns a model for the given {@code descriptor}.
* @param descriptor the descriptor

2
spring-restdocs-core/src/main/java/org/springframework/restdocs/request/RequestParametersSnippet.java
View File

@@ -133,7 +133,7 @@ public class RequestParametersSnippet extends AbstractParametersSnippet {
public RequestParametersSnippet and(List<ParameterDescriptor> additionalDescriptors) {
List<ParameterDescriptor> combinedDescriptors = new ArrayList<>(getParameterDescriptors().values());
combinedDescriptors.addAll(additionalDescriptors);
return new RequestParametersSnippet(combinedDescriptors, this.getAttributes());
return new RequestParametersSnippet(combinedDescriptors, this.getAttributes(), this.isIgnoreUndocumentedParameters());
}
}

9
spring-restdocs-core/src/test/java/org/springframework/restdocs/request/RequestParametersSnippetTests.java
View File

@@ -153,6 +153,15 @@ public class RequestParametersSnippetTests extends AbstractSnippetTests {
.is(tableWithHeader("Parameter", "Description").row("`a`", "one").row("`b`", "two"));
}
@Test
public void additionalDescriptorsWithRelaxedRequestParameters() throws IOException {
RequestDocumentation.relaxedRequestParameters(parameterWithName("a").description("one"))
.and(parameterWithName("b").description("two")).document(this.operationBuilder
.request("http://localhost").param("a", "bravo").param("b", "bravo").param("c", "undocumented").build());
assertThat(this.generatedSnippets.requestParameters())
.is(tableWithHeader("Parameter", "Description").row("`a`", "one").row("`b`", "two"));
}
@Test
public void requestParametersWithEscapedContent() throws IOException {
RequestDocumentation.requestParameters(parameterWithName("Foo|Bar").description("one|two"))