From 51bb9ea22257e62773b6c405b5c06ee90cde5a0f Mon Sep 17 00:00:00 2001
From: Reuven <rh@tufin.com>
Date: Tue, 31 May 2022 23:58:03 +0300
Subject: [PATCH] explain how to use filter recursively

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 8dd5f96e..71986995 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,8 @@ oasdiff -fail-on-diff -breaking-only -format text -base https://raw.githubuserco
 ```bash
 oasdiff -format text -filter "/api" -base https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml -revision https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test3.yaml
 ```
+Notes:
+1. Filters are applied recursively at all levels. For example, if a path contains a [callback](https://swagger.io/docs/specification/callbacks/), the filter will be applied both to the path itself and to the callback path. To include such a nested change, use a regular expression that contains both paths, for example ```-filter "path|callback-path"```
 
 ### Exclude paths and operations with extension "x-beta"
 ```bash