Skip to content
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.

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

Please document the ProxyMatch "Path" pattern syntax #914

Closed
aschuhardt opened this issue Apr 13, 2021 · 5 comments · Fixed by #1039
Closed

Please document the ProxyMatch "Path" pattern syntax #914

aschuhardt opened this issue Apr 13, 2021 · 5 comments · Fixed by #1039
Assignees
Labels
Type: Documentation Improvements or additions to documentation
Milestone

Comments

@aschuhardt
Copy link

aschuhardt commented Apr 13, 2021

What should we add or change to make your life better?

Provide documentation for how to write ProxyMatch path patterns.

Why is this important to you?

The examples provided only illustrate that the string /{**catch-all} works, somehow, and doesn't go into any detail about the syntax used. I have no idea how to use this.

Questions:

  • Does the word "catch-all" have special meaning?
  • What does ** mean? Is it different from a single *?
  • How do I specify more complex patterns?
  • Can we specify exclusions? i.e. /{^error} or something to exclude paths that start with the word "error"
@aschuhardt aschuhardt added the Type: Idea This issue is a high-level idea for discussion. label Apr 13, 2021
@Tratcher
Copy link
Member

The path pattern is passed through to the AspNetCore routing system which is documented here:
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/routing?view=aspnetcore-5.0#route-template-reference

We should make sure our docs have the appropriate references back to the AspNetCore docs.

@Tratcher Tratcher added Type: Documentation Improvements or additions to documentation and removed Type: Idea This issue is a high-level idea for discussion. labels Apr 13, 2021
@aschuhardt
Copy link
Author

The path pattern is passed through to the AspNetCore routing system which is documented here:
https://docs.microsoft.com/en-us/aspnet/core/fundamentals/routing?view=aspnetcore-5.0#route-template-reference

We should make sure our docs have the appropriate references back to the AspNetCore docs.

Thank you for that info. Yes having that link someplace in the YARP docs would be very helpful.

@Tratcher Tratcher reopened this Apr 13, 2021
@karelz
Copy link
Member

karelz commented Apr 22, 2021

Triage: We should provide link from our docs.

@karelz karelz added this to the YARP 1.0.0 milestone Apr 22, 2021
@karelz karelz added this to Unscheduled in YARP Planning via automation Apr 22, 2021
@karelz karelz moved this from Unscheduled to 1.0 Backlog in YARP Planning Apr 22, 2021
@alnikola alnikola self-assigned this Jun 1, 2021
@jeremyb35
Copy link

Did you find a way to specify an exclusion ?
I'm looking for the exact same thing, but I cannot find any way to do it after many hours of research...

I've also tried to put regex, but it did not work at all :(

@aschuhardt
Copy link
Author

Did you find a way to specify an exclusion ? I'm looking for the exact same thing, but I cannot find any way to do it after many hours of research...

I've also tried to put regex, but it did not work at all :(

I didn't.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants