Skip to content

Path parameters snippet uses *name as the name of a {*name} capture variable #1079

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
Nov 4, 2026
Merged

Path parameters snippet uses *name as the name of a {*name} capture variable #1079

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
3 changes: 2 additions & 1 deletion ...stdocs-core/src/main/java/org/springframework/restdocs/request/PathParametersSnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,8 @@ private String extractUrlTemplate(Operation operation) {

private static String getParameterName(String match) {
int colonIndex = match.indexOf(':');
return (colonIndex != -1) ? match.substring(0, colonIndex) : match;
String name = (colonIndex != -1) ? match.substring(0, colonIndex) : match;
return name.startsWith("*") ? name.substring(1) : name;
}

@Override
Expand Down
13 changes: 13 additions & 0 deletions ...s-core/src/test/java/org/springframework/restdocs/request/PathParametersSnippetTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,19 @@ void additionalDescriptorsWithRelaxedRequestParameters(OperationBuilder operatio
.row("`b`", "two"));
}

@RenderedSnippetTest
void pathParametersWithCaptureVariable(OperationBuilder operationBuilder, AssertableSnippets snippets,
TemplateFormat templateFormat) throws IOException {
new PathParametersSnippet(
Arrays.asList(parameterWithName("a").description("one"), parameterWithName("b").description("two")))
.document(operationBuilder.attribute(RestDocumentationGenerator.ATTRIBUTE_NAME_URL_TEMPLATE, "/{a}/{*b}")
.build());
assertThat(snippets.pathParameters()).isTable(
(table) -> table.withTitleAndHeader(getTitle(templateFormat, "/{a}/{*b}"), "Parameter", "Description")
.row("`a`", "one")
.row("`b`", "two"));
}

@RenderedSnippetTest
void pathParametersWithEscapedContent(OperationBuilder operationBuilder, AssertableSnippets snippets,
TemplateFormat templateFormat) throws IOException {
Expand Down
Loading