Remove constraints from route parameters in path #2231
Merged
Conversation
This file contains 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
| @@ -47,5 +47,26 @@ public static IEnumerable<object> CustomAttributes(this ApiDescription apiDescri | |||
|
|
|||
| customAttributes = Enumerable.Empty<object>(); | |||
| } | |||
|
|
|||
| internal static string RelativePathSansParameterConstraints(this ApiDescription apiDescription) | |||
| { | |||
There was a problem hiding this comment.
Could this be done with a Regex replace? I feel that would be a little cleaner but not sure about perf implications.
There was a problem hiding this comment.
Perhaps! Admittedly, I'm by now means a regex expert but things get pretty gnarly when you try to capture all of the requirements for the matcher in regex form (matching '?', '=', or ':', handling regex constraints, etc).
In generally, we've avoid parsing routes with regex over in ASP.NET Core. We'll usually roll out token enumerator implementation (ref) to handle this.
I do agree that some code comments might make this a little bit easier to read/maintain.
test/Swashbuckle.AspNetCore.SwaggerGen.Test/SwaggerGenerator/SwaggerGeneratorTests.cs
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes dotnet/aspnetcore#36413.
This fix expands on the changes made in #2209.
Currently, the route constraints that are included in the route template path are included in the generated schema which breaks things like the
curlcommand generated in the UI. This resolves that issue by stripping out constraints/qualifiers from the path.Note that there is work tracked in dotnet/aspnetcore#36525 to ensure that these route constraints show up in the schema.