Replace dynamicMetadata with filters in user-guides (#987)

Signed-off-by: Adam Cattermole <[email protected]>
Kuadrant · Nov 7, 2024 · 0641157 · 0641157
1 parent a46de69
commit 0641157
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/doc/reference/authpolicy.md b/doc/reference/authpolicy.md
@@ -107,10 +107,10 @@
 
 ##### SuccessResponseSpec
 
-| **Field**         | **Type**                                                 | **Required** | **Description**                                                                                                                                   |
-|-------------------|----------------------------------------------------------|:------------:|---------------------------------------------------------------------------------------------------------------------------------------------------|
-| `headers`         | Map<String: [SuccessResponseItem](#successresponseitem)> | No           | Custom success response items wrapped as HTTP headers to be injected in the request.                                                              |
-| `dynamicMetadata` | Map<String: [SuccessResponseItem](#successresponseitem)> | No           | Custom success response items wrapped as Envoy Dynamic Metadata. Use it to pass data along to other proxy filters, such as the rate-limit filter. |
+| **Field** | **Type**                                                 | **Required** | **Description**                                                                                      |
+|-----------|----------------------------------------------------------|:------------:|------------------------------------------------------------------------------------------------------|
+| `headers` | Map<String: [SuccessResponseItem](#successresponseitem)> |      No      | Custom success response items wrapped as HTTP headers to be injected in the request.                 |
+| `filters` | Map<String: [SuccessResponseItem](#successresponseitem)> |      No      | Custom success response items made available to other filters managed by Kuadrant (i.e. Rate Limit). |
 
 ###### SuccessResponseItem
 

diff --git a/doc/user-guides/authenticated-rl-for-app-developers.md b/doc/user-guides/authenticated-rl-for-app-developers.md
@@ -140,7 +140,7 @@ spec:
             prefix: APIKEY
     response:
       success:
-        dynamicMetadata:
+        filters:
           "identity":
             json:
               properties:

diff --git a/doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.md b/doc/user-guides/authenticated-rl-with-jwt-and-k8s-authnz.md
@@ -158,7 +158,7 @@ spec:
             selector: auth.identity.sub
     response:
       success:
-        dynamicMetadata:
+        filters:
           "identity":
             json:
               properties:

diff --git a/doc/user-guides/secure-protect-connect.md b/doc/user-guides/secure-protect-connect.md
@@ -427,7 +427,7 @@ spec:
             prefix: APIKEY
     response:
       success:
-        dynamicMetadata:
+        filters:
           "identity":
             json:
               properties:

diff --git a/examples/toystore/authpolicy.yaml b/examples/toystore/authpolicy.yaml
@@ -20,7 +20,7 @@ spec:
           prefix: APIKEY
     response:
       success:
-        dynamicMetadata:
+        filters:
           "ext_auth_data":
             json:
               properties: