Skip to content

Commit c312bfc

Browse files
committed
docs: enhance README.md with detailed explanation of path matching behavior
1 parent 5c0f4d3 commit c312bfc

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ public class Main {
195195
196196
### Path Matching while comparing two OpenAPI paths
197197
198-
Path matching controls how paths from the old and new specs are paired during comparison. The default matcher (DefaultPathMatcher) normalizes templated segments so that, for example, `/users/{id}` matches `/users/{userId}`. Fails on ambiguous signatures.
198+
Path matching controls how paths from the old and new specs are paired during comparison (PathsDiff.java). The default matcher (DefaultPathMatcher) obfuscates path parameter names, meaning `/users/{id}` matches `/users/{userId}`. Default matcher fails on ambiguous signatures if spec contains few paths semantically identical. In case this behaviour is not fitting your use case, you can implement your own matching strategy.
199199
200200
You can plug in a custom matcher via `OpenApiDiffOptions` implementing the `PathMatcher` interface.:
201201

0 commit comments

Comments
 (0)